Get what a channel plays
This endpoint returns what a Cloud Playout channel plays and when, as a flat timeline. It works for both channel types, and is the endpoint to use when you want the actual running order rather than the configuration behind it.
How it works
-
Make a GET request to this endpoint with the
channelIdand the channel’stype. -
The response returns the timeline in play order, with every entry carrying its own
startTime,endTimeandduration. -
Narrow the response to a period with
startTimeandendTime.
For a loop channel the programs are expanded into the times they actually play, pass after pass, so an item that comes round four times appears four times. Bumpers appear as entries of their own, in the place they play, carrying bumperId and bumperName.
For a schedule channel the bumpers belong to the event instead, and are returned nested in the entry’s bumper object as preroll and postroll rather than as entries of their own. Each carries the id of the media that plays for the bumper, the bumperId, its name and its duration. A bumper plays inside the event’s slot, so the preroll runs from the entry’s startTime for its duration, the postroll ends at the entry’s endTime, and the main media fills what is left between them.
A vod entry’s name is the media’s title (set with title on the create media or update media endpoints; metadata.name is not used), or the media’s id when it has no title. videoCount is the number of items configured on the channel, not the number of entries in the window.
Example
A channel guide shows viewers what is on now and next by asking for the timeline between now and two hours ahead.
Authentication
FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.
- Username: Access Token ID
- Password: Secret Key
Activate your FastPix account to generate your API credentials. See the guide here
Path parameters
Query parameters
Only return what plays at or after this time, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC.
Only return what plays at or before this time, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC. It must be later than startTime.