Skip to navigation
CLOUD PLAYOUT APISchedule channel

Get the events on a schedule channel

This endpoint retrieves the events scheduled on a Cloud Playout schedule channel, in the order they play. The id in the path is the channel’s ID.

How it works

  1. Make a GET request to this endpoint with the channelId.

  2. The response returns each event with its type, what it plays, when it runs, and any bumpers attached to it.

  3. Narrow the response to a period with startTime and endTime. Leave both out to get the whole timeline.

Events are returned in full, without pagination.

Example

A playout dashboard loads tomorrow’s line-up for a channel by asking for the events between midnight and midnight.

Authentication

AuthorizationBasic

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

idstringRequiredformat: "uuid"
The unique identifier of the schedule channel whose events are retrieved.

Query parameters

startTimestringOptional

Only return events at or after this time, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC.

endTimestringOptional

Only return events at or before this time, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC. It can be sent on its own to return everything up to that point.

Response

Schedule channel events retrieved successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
datalist of objectsOptional
The events on the channel, in the order they play.