Link Search Menu Expand Document

IMPORTANT: This documentation is a work in progress. Please keep checking for latest changes to remain updated.

Story

Story is a single self contained unit of data, describing a news item, along with its metadata like authors, sections, tags etc. Story should always be in the below format for the Quintype platform

Format

{
  "external-id": "external-id-4",
  "headline": "Attractive headline",
  "subheadline": "Attractive subheadline",
  "slug": "slug",
  "first-published-at": 962582400000,
  "last-published-at": 962582400000,
  "published-at": 962582400000,
  "story-template": "text",
  "temporary-hero-image-url":"http://domain.com/some-image.jpg",
  "hero-image-metadata": {
    "width": 980,
    "height":420
  },
  "hero-image-caption": "Attractive caption",
  "hero-image-attribution": "Image attribute",
  "status": "open,published",
  "authors": [
    {
      "email": "foo@foo.com",
      "name": "Foo Bar",
      "username": "Foo Bar",
      "external-id": "external-id-1"
    }
  ],
  "sections": [
    {
      "external-id": "external-id-section-1",
      "name": "Section Name",
      "slug": "section-name",
      "parent": {
        "external-id": "external-id-section-2",
        "name": "Section Name",
        "slug": "section-name",
        "parent": {
          "...": "..."
        }
      }
    }
  ],
  "tags": [
    {
      "external-id": "Tag id",
      "name": "First Tag",
      "slug": "tag1"
    },
    {
      "external-id": "Tag id",
      "name": "First Tag",
      "type": "type provided by support"
    }
  ],
  "summary": "Suitable Summary.",
  "body": "<p>Some Body</p>",
  "story-elements": [
    {

    }
  ],
  "cards": [
    {

    }
  ],
  "seo":{
    "meta-description":"Some meta description",
    "meta-title":"Some title",
    "meta-keywords":["keyword1", "keyword2"]
  },
  "metadata": {
    "key": "value"
  },
  "access": "",
  "access-level-value": 100
}

Schema

Key Type
external-id* String
headline* String
subheadline String
slug*[3] String
first-published-at* Epoch time in milliseconds
last-published-at* Epoch time in milliseconds
published-at* Epoch time in milliseconds
story-template* String
temporary-hero-image-url String
hero-image-metadata[4] Object
hero-image-attribution String
hero-image-caption String
status String, Values should be open or published
authors* Array of Authors
sections* Array of Sections
tags Array of Tags
summary String
body* Rich text string
seo Object
metadata [2] Object, muliple keys and values can be passed
access String, Values should be public, login, subscription
access-level-value Number

Hero image metadata

Key Type
width * Number( representing width of image in pixels )
height * Number( representing height of image in pixels )

author

Key Type
name * String
username * String
email * String
external-id * String

section

Key Type
external-id * String
name * String
slug * String
parent Section

tag

Key Type
external-id String
name * String
slug String
type ( in case of Entity ) String

story elements

Please connect with Quintype support for using story elements for migration. If you are a Quintype partner, click here for Story Elements

card

Please connect with Quintype support to understand what is cards, and the format of cards

seo

Key Type
meta-description String
meta-title String
meta-keywords Array of Strings

Notes

[1] All mandatory fields are marked with an *

[2] If you have more data in your current system, apart from the above representation, all those keys & values can be passed inside this metadata object. This data will only be available using the API, will not be shown anywhere in the Quintype user interface

[3] Slug should be alphanumeric string with hyphen as a delimiter of words. String should not begin or end with a hyphen. Characters should be in lowercase. Other special characters and consecutive hyphens are invalid.

Example

Slug Validity
testslug01
test1-01-slug
test-Slug
slug!test
-slug-test-

[4] Hero-image-metadata is mandatory if a hero-image is provided. It makes sure the image is rendered correctly on the page for different device screens.


Table of contents