Get the items in a program

GET

https://api.fastpix.com/v1/cloud-playout/channels/:channelId/programs/:programId/media-details

GET

/v1/cloud-playout/channels/:channelId/programs/:programId/media-details

curl https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/programs/d85083a0-e935-4c29-9c32-6720bdc9b22f/media-details \
     -u "<username>:<password>"

200Retrieved

{
  "success": true,
  "data": [
    {
      "id": "4a1e1f3b-2c0d-4c4a-9a02-1d7e5f6b8c90",
      "index": 10,
      "programId": "d85083a0-e935-4c29-9c32-6720bdc9b22f",
      "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21",
      "name": "Morning headlines",
      "type": "vod",
      "duration": "00:10:30.500",
      "thumbnail": "https://images.fastpix.com/8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21/thumbnail.png",
      "sourceResolution": "1080p",
      "segments": [
        {
          "id": "6f0b6a3c-6c1e-4c15-9a2e-58b1b0a3c5d1",
          "segmentMediaId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21",
          "startTime": 0,
          "duration": 300,
          "bumper": {
            "preroll": {
              "id": "9d9f2c67-0a25-4b3e-9a70-1a5c1d2b6f88",
              "name": "Ad break intro",
              "duration": 5,
              "durationMillis": 5040,
              "thumbnail": "https://images.fastpix.com/9d9f2c67-0a25-4b3e-9a70-1a5c1d2b6f88/thumbnail.png"
            }
          }
        }
      ]
    },
    {
      "id": "7b4d9a12-5f3c-4c8e-9d21-3a7e2c5b1f04",
      "index": 20,
      "programId": "d85083a0-e935-4c29-9c32-6720bdc9b22f",
      "referenceId": "Evening match",
      "type": "live",
      "duration": "02:00:00",
      "thumbnail": null,
      "sourceResolution": null,
      "segments": []
    }
  ]
}

This endpoint retrieves every item in a program on a Cloud Playout loop channel, in the order the channel plays them. Each item carries the segments defined on it, along with any bumpers attached to those segments.

How it works

Make a GET request to this endpoint with the channelId and the programId.
The response returns the program’s items in play order, each with its type, duration and referenceId.
For each item, segments lists the time windows marked on it, and each segment’s bumper shows the pre-roll and post-roll attached to that window.

Items are returned in full, without pagination.

Example

A playout dashboard renders the rundown for a program, showing each item in order together with the ad breaks marked on it and the bumpers that play around them.

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

channelIdstringRequiredformat: "uuid"

The unique identifier of the loop channel the program belongs to.

programIdstringRequiredformat: "uuid"

The unique identifier of the program whose items are retrieved.

Response

Program items retrieved successfully

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

datalist of objectsOptional

The items in the program, in the order the channel plays them.