Popular Recommendation API

The following describes how to set up popular video recommendations via the following API route

Feature:

  1. Ability to request recommendations that are currently popular across a publishers video library that can be used to populate a carousel or build a channel

Requirements:

  1. client_token: The client token provided by the IRIS.TV team
  2. access_token: The access token provided by the IRIS.TV team

Formatting the Requests:

The IRIS.TV Popular API will generate a list of assets that are currently popular across a publishers video library.

API Request:

https://api.iris.tv/api/v1/lists/popular

Example of the Request:

https://api.iris.tv/api/v1/lists/popular?client_token=LPUA918&access_token=Q12OT1VP3U38UCTJRF5R

Receiving the List of Assets:

The Popular Recommendation API will respond with a list of recommendations in following format:

{ "results": <list>, "count": <int>, "next": <str|None>, "prev": <str|None> }

Definition of Parameters:

  • Results: List of assets for the route
  • Count: The number of results
  • Next: Complete URL for the next page of results
  • Prev: Complete URL for the previous page of results
*Note: Next and Previous can be null if none exist.