Introduction to Quintype APIs

API name

/api/v1/search

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/search?fields=headline%2C%20tags%2Cslug%2C%20last-published-at%2C&limit=5&q=Indian%20cricket" -H "Accept: application/json"


Example Response

{  
   "results":{  
      "from":0,
      "size":5,
      "total":45,
      "stories":[  
         {  
            "headline":"L&T to build world's biggest cricket stadium at Motera",
            "tags":[  
               {  
                  "id":275035,
                  "name":"National",
                  "slug":"national"
               }
            ],
            "slug":"national/2016/12/09/storystadiumabc",
            "last-published-at":1482220906320
         },
         {  
            "headline":"When is Tesla entering the Indian market?",
            "tags":[  
               {  
                  "id":331448,
                  "name":"Tesla",
                  "slug":"tesla"
               }
            ],
            "slug":"technology/2017/02/23/When-is-Tesla-entering-the-Indian-market",
            "last-published-at":1487840302541
         },
         {  
            "headline":"9/11 and the unsolvable Afghan drama",
            "tags":[  
               {  
                  "id":17518,
                  "name":"Dhoni",
                  "meta-description":null,
                  "slug":"dhoni"
               },
               {  
                  "id":505844,
                  "name":"indiabq",
                  "meta-description":null,
                  "slug":"indiabq"
               }
            ],
            "slug":"politics/2017/09/13/afghan-drama",
            "last-published-at":1505284207024
         },
      ],
      "term":"Indian cricket"
   }
}

Description

Returns a list of stories.

Input Parameters

Name	Data Type	Description
q	string	The search string
author	string	The author name
author-id	integer	The author ID
fields	string	The parameters of a story, such as headline, slug, section, author ID, story ID, and so on.
limit	integer	The number of stories to display. The default is 20.
offset	integer	The distance from the start of the array of stories to the reference point in the array.
sort	string	Returns stories based on ascending or descending order
published-before	integer	The date in Epoch format
published-after	integer	The date in Epoch format

/api/v1/stories

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/stories?limit=2  -H "Accept: application/json"

Example Response

{  
   "stories":[  
      {  
         "author-name":"Michele Mag",
         "headline":"Dangal reviews: Aamir Khan gets a salute from all of Bollywood",
         "slug":"entertainment/2016/12/23/storyabcphoto",
         "last-published-at":1504268716413,
         "sections":[  
            {  
               "id":81,
               "name":"Entertainment",
               "display-name":"Entertainment",
               "slug":"entertainment",
               "collection":null
            }
         ],
         "hero-image-metadata":{  
            "width":640,
            "height":480,
            "mime-type":"image/jpeg",
            "focus-point":[  
               326,
               240
            ]
         },
         "published-at":1504268716413,
         "id":"01436fae-fb15-42e5-9b3b-e57b93de21f0",
         "author-id":5278,
         "first-published-at":1482482240320,
         "story-template":"photo",
         "metadata":{  
            "card-share":{  
               "shareable":true
            }
         }
      },
      {  
         "author-name":"Sriram K",
         "headline":"9/11 and the unsolvable Afghan drama",
         "slug":"politics/2017/09/13/afghan-drama",
         "last-published-at":1505284207024,
         "sections":[  
            {  
               "id":83,
               "name":"Politics",
               "display-name":null,
               "slug":"politics",
               "parent-id":null,
               "collection":{  
                  "id":4364,
                  "name":"The Quint",
                  "slug":"the-quint"
               }
            },
            {  
               "id":98,
               "name":"Current Affairs",
               "display-name":null,
               "slug":"current-affairs",
               "parent-id":null,
               "collection":null
            }
         ],
         "hero-image-metadata":{  
            "width":5120,
            "height":3620,
            "focus-point":[  
               3977,
               737
            ]
         },
         "published-at":1505284207024,
         "id":"8339b599-3eab-4428-9486-9139d28bb1ba",
         "author-id":61657,
         "first-published-at":1505284207024,
         "story-template":null,
         "metadata":{  
            "card-share":{  
               "shareable":true
            }
         }
      }
   ]
}

Description

Returns a list of stories and the story details, such as the author name and author ID, story headline, story slug, the list of sections ID and section name that the story belongs to, story template, metadata, and so on.

Input Parameters

Name	Data Type	Description
section-id	integer	The section ID of a story
section	string	The name of a section
fields	string	The parameters of a story, such as headline, slug, section, author ID, story ID, and so on.
limit	integer	The number of stories to display. The default is 20.
offset	integer	The distance from the start of the array of stories to the reference point in the array.
story-order	string	Displays stories in the specified order, such as top, last-updated, and so on.
template	string	The name of the story template. For example, video, live-blog, photo-story, and so on.
tag	string	The name of the tags.
randomize	string	Displays list of random stories.
not-story-content-ids	string	The stories other than the mentioned story IDs.

/api/v1/stories-by-slug

Example Request

$ curl -X GET "https://sketches.quintype.com/api/v1/stories-by-slug?slug=technology/2017/09/14/iphone-x-vs-samsung-galaxy-note-8"  -H "Accept: application/json"

Example Response

{  
   "story":{  
      "seo":{  
         "meta-description":"comparison between iphone X and galaxy s8",
         "meta-title":"smartphone, apple vs samsung",
         "meta-keywords":[  
            "politics"
         ],
         "meta-google-news-standout":false,
      },
      "assignee-id":323432,
      "author-name":"Vineet",
      "tags":[  
         {  
            "id":257701,
            "name":"iphone;",
            "meta-description":null,
            "slug":"iphone"
         },
         {  
            "id":506781,
            "name":"smartphone",
            "meta-description":null,
            "slug":"smartphone"
         }
      ],
      "headline":"iPhone X vs Samsung Galaxy Note 8",
      "storyline-id":null,
      "votes":{},
      "story-content-id":"ef91900e-2a7d-42c6-8ccc-fb75db2a4504",
      "slug":"technology/2017/09/14/iphone-x-vs-samsung-galaxy-note-8",
      "last-published-at":1512732026172,
      "subheadline":"A battle for smartphone dominance",
      "sections":[  
         {  
            "id":84,
            "name":"Technology",
            "display-name":null,
            "slug":"technology",
            "parent-id":null,
            "collection":null
         }
      ],
      "content-created-at":1505383805868,
      "owner-name":"Vineet"      
      "publisher-id":15,
      "hero-image-metadata":{  
         "width":616,
         "height":347,
         "mime-type":"image/jpeg",
         "focus-point":[  
            408,
            232
         ]
      },
      "published-at":1512732026172,
      "is-live-blog":false,
      "breaking-news-linked-story-id":null,
      "summary":"Iphone vs Samsung",
      "status":"published",
      "bullet-type":"123",
      "id":"ef91900e-2a7d-42c6-8ccc-fb75db2a4504",
      "hero-image-s3-key":"quintype-demo/2016-11/20d960e9-cbb4-46c0-a6cc-3819c326f766/pixelxl-iphone7plus-30.jpg",
      "cards":[  
         {  
            "story-elements":[  
               {  
                  "description":"",
                  "page-url":"/story/ef91900e-2a7d-42c6-8ccc-fb75db2a4504/element/690b7304-d875-484a-9850-33c9eb360537",
                  "type":"youtube-video",
                  "url":"https://www.youtube.com/watch?v=iGpVs3wFKF0#action=share",
                  "embed-url":"https://www.youtube.com/embed/iGpVs3wFKF0#action=share",
                  "metadata":{  

                  },
               {   
                  "page-url":"/story/ef91900e-2a7d-42c6-8ccc-fb75db2a4504/element/f693466d-2c8f-49fa-9d10-d26ff4f05ae3",
                  "type":"jsembed",
                  "metadata":{  
                     "tweet-url":"https://twitter.com/Apple/status/907700942715228160",
                     "provider":"twitter",
                     "tweet-id":"907700942715228160"
                  },
                  "subtype":"tweet"
               }
            ],
            "status":"draft",
            "id":"afce3ef4-1036-4c1f-9d0e-997cde4dda4d",
            "content-id":"afce3ef4-1036-4c1f-9d0e-997cde4dda4d",
            "version":4,
         },
         {  
            "story-elements":[  
               {  
                  "description":"",
                  "page-url":"/story/ef91900e-2a7d-42c6-8ccc-fb75db2a4504/element/a99de097-11b7-4de6-8c22-6ef5ea2f03c1",
                  "type":"jsembed",
                  "family-id":"7b056ac4-c226-4650-99a9-0b11ed354335",
                  "title":"",
                  "id":"a99de097-11b7-4de6-8c22-6ef5ea2f03c1",

               },
               {  
                  "description":"",
                  "page-url":"/story/ef91900e-2a7d-42c6-8ccc-fb75db2a4504/element/c5b14bcd-4be2-46d9-9f46-43ea4e6bd3ac",
                  "type":"jsembed",
               },
               "subtype":"location"
            }
         ],
         "status":"draft",
         "id":"6e14e3ed-529f-4d53-a290-175691c955b2",
         "content-id":"6e14e3ed-529f-4d53-a290-175691c955b2",
         "version":2,
         "metadata":{  
            "social-share":{  
               "shareable":true,
               "title":"iPhone X vs Samsung Galaxy Note 8",
               "message":"Iphone vs Samsung",

            }
         }
      }
   ],
   "story-version-id":"f8526a61-6264-4dca-a12b-0ca1d067ede2",
   "content-type":"story",
   "author-id":323432,
   "owner-id":323432,
   "version":16,
   "story-template":"video",
   "authors":[  
      {  
         "id":323432,
         "name":"Vineet",
         "slug":"vineet",

      }
   ],
   "metadata":{  
      "card-share":{  
         "shareable":true
      }
   },

}
}

Description

Returns the story having the mentioned slug. The output contains information such as the story author name, author ID, tags, sections, cards, and the metadata associated with that story.

Input Parameters

Name	Data Type	Description
slug	string	The slug for the desired story

/api/v1/stories/{story-id}

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/stories/ef91900e-2a7d-42c6-8ccc-fb75db2a4504"  -H "Accept: application/json"

Example Response

{  
   "story":{  
      "updated-at":1505384172777,
      "seo":{  
         "meta-description":"comparison between iphone X and galaxy s8",
         "meta-title":"smartphone, apple vs samsung",
         "meta-keywords":[  

         ],
         "meta-google-news-standout":false,
         "claim-reviews":{  
            "story":null
         }
      },
      "assignee-id":323432,
      "author-name":"Vineet",
      "tags":[  
         {  
            "id":257701,
            "name":"iphone;",
            "meta-description":null,
            "slug":"iphone"
         },
         {  
            "id":506781,
            "name":"smartphone",
            "meta-description":null,
            "slug":"smartphone"
         }
      ],
      "headline":"iPhone X vs Samsung Galaxy Note 8",
      "storyline-id":null,
      "votes":{  

      },
      "story-content-id":"ef91900e-2a7d-42c6-8ccc-fb75db2a4504",
      "slug":"technology/2017/09/14/iphone-x-vs-samsung-galaxy-note-8",
      "last-published-at":1505384184330,
      "subheadline":"A battle for smartphone dominance",
      "alternative":{  

      },
      "sections":[  
         {  
            "id":84,
            "name":"Technology",
            "display-name":null,
            "slug":"technology",
            "parent-id":null,
            "collection":null
         }
      ],
      "content-created-at":1505383805868,
      "owner-name":"Vineet Panjabi",
      "custom-slug":null,
      "push-notification":null,
      "publisher-id":15,
      "hero-image-metadata":{  
         "width":616,
         "height":347,
         "mime-type":"image/jpeg",
         "focus-point":[  
            418,
            169
         ]
      },
      "comments":null,
      "entities":{  

      },
      "published-at":1505384184330,
      "breaking-news-linked-story-id":null,
      "storyline-title":null,
      "summary":"Iphone vs Samsung",
      "canonical-url":null,
      "autotags":[  

      ],
      "linked-entities":[  

      ],
      "status":"published",
      "hero-image-attribution":null,
      "bullet-type":"123",
      "id":"ef91900e-2a7d-42c6-8ccc-fb75db2a4504",
      "hero-image-s3-key":"quintype-demo/2016-11/20d960e9-cbb4-46c0-a6cc-3819c326f766/pixelxl-iphone7plus-30.jpg",
      "cards":[  
         {  
            "story-elements":[  
               {  
                  "description":"",
                  "page-url":"/story/ef91900e-2a7d-42c6-8ccc-fb75db2a4504/element/690b7304-d875-484a-9850-33c9eb360537",
                  "type":"youtube-video",
                  "family-id":"7267f6e8-808c-455b-81aa-6bd0dd8c7ad5",
                  "title":"",
                  "id":"690b7304-d875-484a-9850-33c9eb360537",
               },
            ],
            "card-updated-at":1505384055361,
            "content-version-id":"6445d74d-1079-4244-a5a1-5b8403cf88cc",
            "card-added-at":1505383805931,
            "status":"draft",
            "id":"afce3ef4-1036-4c1f-9d0e-997cde4dda4d",
            "content-id":"afce3ef4-1036-4c1f-9d0e-997cde4dda4d",
            "version":3,
            "metadata":{  
               "social-share":{  
                  "shareable":true,
                  "title":"iPhone X vs Samsung Galaxy Note 8",
                  "message":"Iphone vs Samsung",
                  "image":{  
                     "key":"pixelxl-iphone7plus-30.jpg",
                     "url":null,
                     "attribution":null,
                     "caption":"Best in class.",
                     "metadata":{  
                        "width":616,
                        "height":347,
                        "mime-type":"image/jpeg",
                        "focus-point":[  
                           418,
                           169
                        ]
                     }
                  }
               }
            }
         }
      ],
      "story-version-id":"1603c682-699e-48ea-9354-7e265ca7c1f8",
      "content-type":"story",
      "content-updated-at":1509011137120,
      "author-id":323432,
      "owner-id":323432,
      "access":null,
      "first-published-at":1505384184330,
      "hero-image-caption":"Best in class.",
      "version":4,
      "story-template":"video",
      "sequence-no":null,
      "created-at":1505384127930,
      "authors":null,
      "metadata":{  
         "card-share":{  
            "shareable":true
         }
      },
      "publish-at":null,
      "assignee-name":"Vineet
   }
}

Description

Returns the story details having the mentioned story ID.

Input Parameters

Name	Data Type	Description
story-id	UUID	The story ID

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/stories/db09a326-3af2-4286-a92b-8ffbc9bb3c4f/related-stories?fields=headline,id,slug,author-name"  -H "Accept: application/json"

Example Response
{  
   "related-stories":[  
      {  
         "headline":"Okuhara reigns at Glasgow",
         "id":"496b653b-cb45-4843-9f1d-273b7a81900b",
         "slug":"sports/2017/08/30/okuhara-reigns-at-glasgow",
         "author-name":"Tapan"
      },ff
      {  
         "headline":"iPhone X vs Samsung Galaxy Note 8",
         "id":"ef91900e-2a7d-42c6-8ccc-fb75db2a4504",
         "slug":"technology/2017/09/14/iphone-x-vs-samsung-galaxy-note-8",
         "author-name":"Vineet"
      },
      {  
         "headline":"9/11 and the unsolvable Afghan drama",
         "id":"8339b599-3eab-4428-9486-9139d28bb1ba",
         "slug":"politics/2017/09/13/afghan-drama",
         "author-name":"Sriram"
      }
   ]
}

Description

Returns the stories that are related to the mentioned story ID.

Input Parameters

Name	Data Type	Description
story-id	UUID	The story ID
section-id	string	The section ID of a story
fields	string	The parameters of a story, such as headline, slug, sections, author ID, and so on.

/api/v1/bulk

Example Request

$ curl 'http://sketches.quintype.com/api/v1/bulk' -H 'Content-Type: application/json' --data-binary '{"requests":{"sports":{"slug":"sports","limit":"4","_type":"collection"},"history":{"slug":"history","limit":"4","_type":"collection"}}}' --compressed;

Example Response

{  
   "results":{  
      "sports":{  
         "updated-at":1507616006917,
         "slug":"sports",
         "name":"Sports",
         "automated":false,
         "template":"default",
         "rules":{  

         },
         "summary":"Sports",
         "id":7595,
         "total-count":1,
         "items":[  
            {  
               "id":7595,
               "type":"collection",
               "name":"Sports Main",
               "slug":"sports-main",
               "template":"default"
            }
         ],
      },
      "history":{  
         "updated-at":1506933499956,
         "slug":"history",
         "name":"History ",
         "automated":false,
         "template":"default",
         "rules":{  
            "content-type":"story",
            "collection-id":7585
         },
         "summary":"History ",
         "id":7587,
         "total-count":1,
         "items":[  
            {  
               "id":7585,
               "type":"collection",
               "name":"History Main",
               "slug":"history-main",
               "template":"default"
            }
         ],
      }
   }
}

Description

Returns multiple responses in a single API request.

/api/v1/collections/{slug}

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/collections/featured-stories"  -H "Accept: application/json"

Example Response

{
   "updated-at": 1506933499956,
   "slug": "history-trails",
   "name": "History Trails",
   "automated": false,
   "template": "default",
   "rules": {
      "content-type": "story",
      "collection-id": 7587
   },
   "summary": "History Trails",
   "id": 7587,
   "total-count": 1,
   "items": [
      {
         "id": 7584,
         "type": "collection",
         "name": "History Trails Main",
         "slug": "history-trails-main",
         "template": "default"
      }
   ],
   "created-at": 1493208539891,
   "metadata": {
   "cover-image": {}
   }
}

Description

Returns the collection based on the slug.

Input Parameters

Name	Data Type	Description
slug	string	The slug for the desired collection
item-type	string	Possible values are story and collection
exclude-story-ids	integer	The story IDs to be excluded from displaying

/api/v1/authors

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/authors" -H "Accept: application/json"

Example Response

{  
   "limit":4,
   "offset":0,
   "total":67
},
"authors":[  
   {  
      "id":2038,
      "name":"Dinjas,
      "avatar-url":"https://lh3.googleusercontent.com/-XdUIqdMkCWA/4252rscbv5M/photo.jpg?sz=50",
      "avatar-s3-key":null,
      "twitter-handle":null,
      "bio":null,
      "metadata":{  

      },
      "slug":"dinjas"
   },
   {  
      "id":2039,
      "name":"Ramit",
      "avatar-url":"https://lh5.googleusercontent.com/-nXlfvt-YsVw/uo5Y2_mFdWc/photo.jpg?sz=50",
      "avatar-s3-key":null,
      "twitter-handle":null,
      "bio":null,
      "metadata":{  

      },
      "slug":"ramit"
   },
   {  
      "id":2040,
      "name":"Villackal",
      "avatar-url":null,
      "avatar-s3-key":null,
      "twitter-handle":null,
      "bio":null,
      "metadata":{  

      },
      "slug":"villackal"
   },
   {  
      "id":2041,
      "name":"Tapan",
      "avatar-url":null,
      "avatar-s3-key":null,
      "twitter-handle":null,
      "bio":null,
      "metadata":{  

      },
      "slug":"tapan"
   }
]
}

Description

Returns the list of authors with the author name and author ID, along with details such as the author's biodata, gender, twitter handle and so on.

Input Parameters

None.

/api/v1/authors/{author-id}


Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/authors/20294 -H "Accept: application/json"

Example Response
{  
   "author":{  
      "id":20294,
      "name":"Abhishek Sharma",
      "slug":"abhishek-sharma",
      "avatar-s3-key":null,
      "twitter-handle":null,
      "bio":null,
      "metadata":{  

      }
   }
}

Description

Returns the author details with the specified author ID.

Input Parameters

Name	Data Type	Description
author-id	integer	The author ID

/api/v1/breaking-news

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/breaking-news" -H "Accept: application/json"

Example Response

{
  "stories": [
    {
      "author-name": "Pragati Saxena",
      "headline": "7 killed in Kabul suicide bombing  ",
      "slug": "{{section}}/{{slug}}",
      "last-published-at": 1510830370210,
      "alternative": {},
      "sections": [],
      "hero-image-metadata": null,
      "published-at": 1510830370210,
      "id": "f3932791-c827-4e88-be67-6e9af6505e3c",
      "hero-image-s3-key": null,
      "author-id": 117631,
      "first-published-at": 1510830370210,
      "story-template": "breaking-news",
      "metadata": {
        "card-share": {
          "shareable": false
        }
    },
      "author-name": "Pragati Saxena",
      "headline": "Notorious cult leader Charles Manson dead  ",
      "slug": "{{section}}/{{slug}}",
      "last-published-at": 1511164690641,
      "alternative": {},
      "sections": [],
      "hero-image-metadata": null,
      "published-at": 1511164690641,
      "id": "83b5d292-31ae-452f-98e7-5d7b05a06f2a",
      "hero-image-s3-key": null,
      "author-id": 117631,
      "first-published-at": 1511164690641,
      "story-template": "breaking-news",
      "metadata": {
        "card-share": {
         "shareable": false
       }
    }
  ]
}

Description

Returns the list of breaking news.

Input Parameters

None.

/api/v1/config

Description

Displays the publisher's configurations, such as the publisher name and ID, SEO metadata, the sections and menu items, and so on.

Input Parameters

None.

/api/v1/entities

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/entities?limit=2&type=book" -H "Accept: application/json"


Example Response

{  
   "entities":[  
      {  
         "updated-at":1494924456440,
         "publisher-id":15,
         "name":"Five Point Someone",
         "type":"book",
         "entity-type-id":1,
         "deleted-at":null,
         "created-by":61657,
         "id":12,
         "last-updated-by":61657,
         "created-at":1494924456440
      },
      {  
         "updated-at":1494921231049,
         "publisher-id":15,
         "name":"The Old Man and the Sea",
         "type":"book",
         "entity-type-id":1,
         "deleted-at":null,
         "created-by":94890,
         "last-updated-by":94890,
         "created-at":1494921231049
      }
   ],
   "total":7
}

Description

Lists all entities.

Input Parameters

Name	Data Type	Description
q	string	The search string, for example
limit	integer	The number of stories to display. The default is 20.
offset	integer	The distance from the start of the array of entities to the reference point in the array.
id	integer	The ID of an entity
ids	string	A list of entity IDs

/api/v1/entities/{id}


Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/entities/12" -H "Accept: application/json"


Example Response
{  
   "entity":{  
      "updated-at":1494924456440,
      "publisher-id":15,
      "name":"Five Point Someone",
      "type":"book",
      "entity-type-id":1,
      "deleted-at":null,
      "created-by":61657,
      "id":12,
      "last-updated-by":61657,
      "created-at":1494924456440
   }
}

Description

Lists the entity having the specified ID.

Input Parameters

Name	Data Type	Description
ID	integer	The entity ID

/api/v1/entities/{id}/{subentity+}


The following request fetches the list of companies established in the year 2015. A relationship had been created between the entities (entity-type) `year` and `companies`. 

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/entities/15557/companies-established-year" -H "Accept: application/json"

Example Response

{
   "relationships": {
      "self": [
         {
            "entity-type": "year",
            "name": "2015",
            "rank": 1,
            "relationship": "self",
            "deleted-at": null,
            "created-by": 232469,
            "id": 15557,
            "last-updated-by": 232469,
            "created-at": 1498647361780
         }
      ],
      "companies-year": [
         {
            "entity-type": "companies-established",
            "name": "The companies established in 2015",
            "rank": 2,
            "relationship": "companies-established-year",
            "id": 21697,
            "companies-established-year": [
               ....  // A list of companies established in 2015
            ],
            "companies-established-year": {
               "id": 15557,
               "name": "2015"
            },
         "last-updated-by": 232469,
         "created-at": 1498648880350,
         }
      ]
   }
}

Description

Lists the subentity details in relation to the entity ID.

Input Parameters

Name	Data Type	Description
ID	integer	The entity ID
subentity	string	A nested entity name

/api/stories/{story-id}/votes

Example Request

$ curl 'http://sketches.quintype.com/api/stories/8f9538f2-1972-4c7a-b1eb-7f8942dd0606/votes' -H 'Content-Type: application/json' --data-binary '{'magnitude': 'yes'}';

Description

Adds vote to the specified story. Note that the user has to be logged in.

Input Parameters

Name	Data Type	Description
story-id	UUID	The story ID

/api/stories/{story-id}/votes

Example Request

$ curl -X GET "http://sketches.quintype.com/api/stories/ef91900e-2a7d-42c6-8ccc-fb75db2a4504/votes" -H "Accept: application/json"


Example Response

Description

Fetches the total number of votes for the specified ID. Note that the user has to be logged in.

Input Parameters

Name	Data Type	Description
story-id	UUID	The story ID

/stories.rss

Example Request

$ curl -X GET "http://sketches.quintype.com/stories.rss" -H "Accept: application/json"

Example Response

<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:media="http://search.yahoo.com/mrss/" xmlns:sy="http://purl.org/rss/1.0/modules/syndication/">
    <channel> 
        <title>Platform</title> 
        <description>Platform</description> 
        <atom:link href="http://sketches.quintype.com/stories.rss?time-period=last-1-month" rel="self" type="application/rss+xml"></atom:link> 
        <language>en-US</language> 
        <lastBuildDate>Tue,
19Dec 2017 04:40:45+0000</lastBuildDate> 
        <sy:updatePeriod>hourly</sy:updatePeriod> 
        <sy:updateFrequency>1</sy:updateFrequency> 
        <item> 
    <title>Indian opener Rohit Sharma’s record-setting third career double hundred.</title> 
    <link>http://www.southmagnews.com/2017/12/18/indian-opener-rohit-sharmas-record-setting-third-career-double-hundred</link> 
    <comments>http://www.southmagnews.com/2017/12/18/indian-opener-rohit-sharmas-record-setting-third-career-double-hundred#comments</comments> 
    <atom:updated>2017-12-18T11:31:48.852Z</atom:updated> 
    <category>cricket</category> 
    <content:encoded> 
        <![  
      CDATA   [  
      <p>Indian opener Rohit Sharma’s record-setting third career double hundred.</p>
   ]
]> 
    </content:encoded> 
</item> 
<item> 
<title> 
GST Network Brings In Option For Filing Of Forms On Monthly Or Quarterly Basis 
</title> 
<link> 
https://magzinenew.com/insta/gst-network-brings-in-option-for-filing-of-forms-on-monthly-or-quarterly-basis 
</link> 
<comments> 
https://magzinenew.com/insta/gst-network-brings-in-option-for-filing-of-forms-on-monthly-or-quarterly-basis#comments 
</comments> 
<guid isPermaLink="false">20a996a0-80ba-4bed-b961-a3d5064bff40</guid> 
<atom:updated>2017-12-19T03:13:36.812Z</atom:updated> 
<atom:author> 
<atom:name>Staff</atom:name> 
<atom:uri>/api/author/17513</atom:uri> 
</atom:author> 
<description> 
<![  
   CDATA   [  
      Taxpayers with annual aggregate turnover up to Rs1.5 crore in the previous financial year can avail the option of filing quarterly returns.
   ]
]> 
</description> 
<media:keywords>GSTN,
GST Return,
Quarterly</media:keywords> 
<media:content height="249" url="https://images.assettype.com/swarajya/2017-11/8b4f08c4-c333-4953-b649-330641d1b341/unnamed.jpg" width="448"> 
<media:title type="html"> 
<![  
   CDATA   [  
      GSTN logo
   ]
]> 
</media:title> 
</media:content> 
<media:thumbnail url="https://images.assettype.com/swarajya/2017-11/8b4f08c4-c333-4953-b649-330641d1b341/unnamed.jpg?w=280" width="280"/> 
<category>Insta</category> 
<content:encoded> 
<![  
   CDATA   [  
      <p>Goods and services tax network (GSTN),
      the IT backbone of the new tax regime,
      on Monday said it has put a new function on its portal to allow taxpayers choose the frequency of filing GSTR 1 form on quarterly or monthly basis.</p>
   ]
]> 
</content:encoded> 
</item> 
</channel> 
</rss>

Description

Displays the RSS feeds of a publisher.

/api/v1/tags/{slug}


Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/tags/temple" -H "Accept: application/json"

Example Response

{  
   "tags":[  
      {  
         "id":407427,
         "name":"temples",
         "meta-description":null,
         "slug":"temples"
      },
      {  
         "id":388924,
         "name":"#temples",
         "meta-description":null,
         "slug":"temples"
      }
   ]
}

Description

Displays the tag ID, name, and the meta description that matches the given slug.

Input Parameters

Name	Data Type	Description
slug	string	The desired tag slug

/api/member/metadata


Example Request

$ curl -X GET "http://sketches.quintype.com/api/member/metadata" -H "Accept: application/json"

Example Response

Awaiting inputs.

Description

Displays the meta description of the current logged-in user.

Input Parameters

None.

/api/member/metadata


Example Request

$ curl -X POST "http://sketches.quintype.com/api/member/metadata" -H "Accept: application/json" -H "Content-Type: json" -d "{}"

Description

Enters the meta description of the current logged-in user.

Input Parameters

None.

/api/v1/members/me


Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/members/me" -H "Accept: application/json"

Example Response

{
  "member": {
    "updated-at": 1517458769183,
    "email": "charansingh@twitter-dummy-email.com",
    "last-name": null,
    "publisher-id": 1,
    "name": "Sai Charan",
    "avatar-url": "http://pbs.twimg.com/profile_images/780788770828267520/5cSBiM5w_normal.jpg",
    "source": null,
    "first-name": null,
    "communication-email": null,
    "bio": null,
    "id": 469192,
    "avatar-s3-key": null,
    "twitter-handle": null,
    "created-at": 1517458769183,
    "metadata": {}
  }
}

Description

Returns the details of the current logged-in user.

Input Parameters

None.

/api/member/forgot-password


Example Request

$ curl -X POST "http://sketches.quintype.com/api/member/forgot-password" -H "Accept: application/json" -H "Content-Type: json" -d "{ \"email\": \"string\"}"

Description

Updates the password.

Input Parameters

Name	Data Type	Description
E-mail	string	The e-mail ID

/api/member

Example Request

$ curl -X POST "http://sketches.quintype.com/api/member" -H "Accept: application/json" -H "Content-Type: json" -d "{"name":"John Doe","username":"johndoe","email":"john@doe.com","password":"mypassword"}"

Description

Adds the name, username, password, and the e-mail ID.

Input Parameters

Name	Data Type	Description
Name	string	The name of the user
Username	string	The username
E-mail	string	The e-mail ID of the user
Password	string	The password for the mentioned username

Example Request

$ curl -X POST "http://sketches.quintype.com/api/member/forgot-password" -H "Accept: application/json" -H "Content-Type: json" -d {"email":"john@doe.com","password":"mypassword"}

Description

Logs in with the username and password.

Input Parameters

Name	Data Type	Description
E-mail	string	The registered e-mail ID of the user
Password	string	The password associated with the username

/api/instant-articles.rss

Description

Returns the list of published instant articles.

As a prerequisite to fetch the instant articles, the publisher front-end should contain the <meta property="fb:pages" content="1234567890123456" /> tag that is provided by Facebook at the time of registering for instant articles.

Input Parameters

None.

/api/v1/amp/story/

Example Request

$ curl -X GET "http://sketches.quintype.com/api/v1/amp/story?slug=international/2018/03/07/test-9" -H "Accept: application/json"

Description

Returns the story in AMP format. The output contains information associated with that story.

Input Parameters

Name	Data Type	Description
slug	string	The slug for the desired story

Errors

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request sucks.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The kitten requested is hidden for administrators only.
404	Not Found -- The specified kitten could not be found.
405	Method Not Allowed -- You tried to access a kitten with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The kitten requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Introduction to Quintype APIs

API name

/api/v1/search

/api/v1/stories

/api/v1/stories-by-slug

/api/v1/stories/{story-id}

/api/v1/stories/{story-id}/related-stories

/api/v1/bulk

/api/v1/collections/{slug}

/api/v1/authors

/api/v1/authors/{author-id}

/api/v1/breaking-news

/api/v1/config

/api/v1/entities

/api/v1/entities/{id}

/api/v1/entities/{id}/{subentity+}

/api/stories/{story-id}/votes

/api/stories/{story-id}/votes

/stories.rss

/api/v1/tags/{slug}

/api/member/metadata

/api/member/metadata

/api/v1/members/me

/api/member/forgot-password

/api/member

/api/member/login

/api/instant-articles.rss

/api/v1/amp/story/

Errors