Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Playback information is stored and retrieved through the Playback Info API.

Endpoints overview:

EndpointHTTP methodPurpose
/user_profiles/{user_profile_id}/assets/{asset_type}/{asset_id}PUTStore playback information for a given asset
/user_profiles/{user_profile_id}/assets/{asset_type}/{asset_id}GETFetch playback information for a given asset
/user_profiles/{user_profile_id}/assets/{asset_type}GETFetch playback information for multiple assets

Playback information can be stored for any Recording, Catchup or VOD asset. The "asset_type" is the type of the watched asset, values "recording", "catchup" and "vod" are supported.

...

Assets can be grouped by any client provided group ID. For example, recording assets can be grouped by series, by providing the series ID as group_id when storing playback information for the asset. This makes it convenient to retrieve all available playback information for some given group. The endpoint to fetch playback information for multiple assets supports filtering. See the JSON API spec for instructions on how to pass filtering parameters. At the moment, only filtering by group ID is supported.

Info

Note:

If filter[group_id] is not provided in the query, then the endpoint returns ungrouped assets and vice versa.