Series

The response to the Series API request contains the representation of a video Series in the Wurl Index. In the Wurl Index, each Series contains a set of Episodes. The 'Series’ publisher determines the selection and order of the Episodes in a Series.

Request URL

https://api.wurl.com/api/series/SERIES_ID?format=json&access_token=TOKEN
  • TOKEN - your Wurl API access token (Get more info at: Authentication Guide)
  • SERIES_ID – a unique, numerical identifier for a Series in the Wurl Index (e.g. 394565)

Properties in the API Response

Name Type Description
id number A number (assigned by Wurl) that uniquely identifies this Series.
description string A description of the Series provided by the publisher.
channelsRank number ChannelsRank is a number reflecting Wurl’s view of the quality of each Series. Scale of 0-100 (100 = highest rank).
link string The publisher-provided URL of the video Series. Typically, a deep link on the publisher’s website.
matchesApp boolean True if the series episodes match the device profile associated with the requesting application, false otherwise.
playback array Similar to an Episode entities playback property, but with attributes only relevant for a Series.
pubDate string The publication date of the most recent Episode in the Series.
thumbnails A thumbnail image associated with the Series.
title string The Series title as provided by the publisher.
totalEpisodes number The number of video Episodes in this Series.
actions array Available actions for this series. See the Action entity for full description.

Entities in the API Response

Name Class Description
Episodes Link collection,episodes,link,wurl-episodes Navigational link to the API representation of the list of video Episodes in this Series.

Actions in the API Response

An API representation of an action that can be applied to a Series.

Name Type Description
href string Navigational link to the referenced API Action.
method string The API method used to perform the Action (e.g. 'POST').
name string The short-form description of an Action that can be applied to a Series (e.g. 'follow-series').
title string The long-form description of the Action (e.g. 'Add this Series to your Watchlist').
fields array An array of variables used to form an API request to perform the Action.

Links in the API Response

Name Description
self The canonical or preferred url to a resource.
schema The url to a resource's json-schema.

Sample API Response

{
  "rel": [
    "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
  ],
  "class": [
    "series"
  ],
  "properties": {
    "id": 394466,
    "description": "CNN delivers the latest breaking news and information on the latest top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN.com provides special reports, video, audio, photo galleries, and interactive guides.",
    "channelsRank": 84.3332506036771,
    "pubDate": "2013-10-08T06:02:04Z",
    "title": "CNN",
    "thumbnails": {
      "default": {
        "url": "http://static0.channels.com/thumbnails/assets/youtube-com/feeds/192-2240/394466/Uploads-by-CNN--jpg"
      }
    },
    "totalEpisodes": 2853,
    "matchesApp": true,
    "link": "http://www.youtube.com/channel/UCupvZG-5ko_eiXAupbDfxWw/videos"
  },
  "entities": [
    {
      "rel": [
        "urn:x-resource:name:episodes"
      ],
      "href": "https://api.wurl.com/api/series/394466/episodes",
      "class": [
        "link",
        "collection"
      ]
    }
  ],
  "actions": [
    {
      "name": "follow-series",
      "href": "https://api.wurl.com/api/follows",
      "title": "Start following a series",
      "method": "POST",
      "fields": [
        {
          "name": "series_id",
          "type": "text",
          "value": 394466
        },
        {
          "name": "user_id",
          "type": "text"
        }
      ]
    },
    {
      "name": "unfollow-series",
      "href": "https://api.wurl.com/api/follows",
      "title": "Stop following a series",
      "method": "DELETE",
      "fields": [
        {
          "name": "series_id",
          "type": "text",
          "value": 394466
        },
        {
          "name": "user_id",
          "type": "text"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/series/394466"
    }
  ]
}

Series

The response to the Series API request contains the representation of a video Series in the Wurl Index. In the Wurl Index, each Series contains a set of Episodes. The 'Series’ publisher determines the selection and order of the Episodes in a Series.

Request URL

https://api.wurl.com/api/series/SERIES_ID?format=json&access_token=TOKEN

Properties in the API Response

Name Type Description
id number A number (assigned by Wurl) that uniquely identifies this Series.
description string A description of the Series provided by the publisher.
channelsRank number ChannelsRank is a number reflecting Wurl’s view of the quality of each Series. Scale of 0-100 (100 = highest rank).
link string The publisher-provided URL of the video Series. Typically, a deep link on the publisher’s website.
matchesApp boolean True if the series episodes match the device profile associated with the requesting application, false otherwise.
playback array Similar to an Episode entities playback property, but with attributes only relevant for a Series.
pubDate string The publication date of the most recent Episode in the Series.
thumbnails A thumbnail image associated with the Series.
title string The Series title as provided by the publisher.
totalEpisodes number The number of video Episodes in this Series.
actions array Available actions for this series. See the Action entity for full description.

Entities in the API Response

Name Class Description
Episodes Link collection,episodes,link,wurl-episodes Navigational link to the API representation of the list of video Episodes in this Series.

Actions in the API Response

An API representation of an action that can be applied to a Series.

Name Type Description
href string Navigational link to the referenced API Action.
method string The API method used to perform the Action (e.g. 'POST').
name string The short-form description of an Action that can be applied to a Series (e.g. 'follow-series').
title string The long-form description of the Action (e.g. 'Add this Series to your Watchlist').
fields array An array of variables used to form an API request to perform the Action.

Links in the API Response

Name Description
self The canonical or preferred url to a resource.
schema The url to a resource's json-schema.

Sample API Response

{
  "rel": [
    "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
  ],
  "class": [
    "series"
  ],
  "properties": {
    "id": 394466,
    "description": "CNN delivers the latest breaking news and information on the latest top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN.com provides special reports, video, audio, photo galleries, and interactive guides.",
    "channelsRank": 84.3332506036771,
    "pubDate": "2013-10-08T06:02:04Z",
    "title": "CNN",
    "thumbnails": {
      "default": {
        "url": "http://static0.channels.com/thumbnails/assets/youtube-com/feeds/192-2240/394466/Uploads-by-CNN--jpg"
      }
    },
    "totalEpisodes": 2853,
    "matchesApp": true,
    "link": "http://www.youtube.com/channel/UCupvZG-5ko_eiXAupbDfxWw/videos"
  },
  "entities": [
    {
      "rel": [
        "urn:x-resource:name:episodes"
      ],
      "href": "https://api.wurl.com/api/series/394466/episodes",
      "class": [
        "link",
        "collection"
      ]
    }
  ],
  "actions": [
    {
      "name": "follow-series",
      "href": "https://api.wurl.com/api/follows",
      "title": "Start following a series",
      "method": "POST",
      "fields": [
        {
          "name": "series_id",
          "type": "text",
          "value": 394466
        },
        {
          "name": "user_id",
          "type": "text"
        }
      ]
    },
    {
      "name": "unfollow-series",
      "href": "https://api.wurl.com/api/follows",
      "title": "Stop following a series",
      "method": "DELETE",
      "fields": [
        {
          "name": "series_id",
          "type": "text",
          "value": 394466
        },
        {
          "name": "user_id",
          "type": "text"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/series/394466"
    }
  ]
}