Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
SSAI

SSAI Session Ad Data Endpoint

Returns a JSON representation of the ad breaks in the targeted session

This endpoint returns only linear breaks.

get/v2/sites/{site_id}/media/{media_id}/ssai_session/{ssai_session_id}/info.json

Path parameters

site_idstring required

Property or site ID that owns a piece of media

media_idstring required

Eight-character, alphanumeric ID that uniquely identifies the media

This can be found on the video detail page in the dashboard.

ssai_session_idstring required

Unique ID of the SSAI session

This value is returned as part of the manifest URI

Response

JSON representation of the ad-content for a SSAI media.

Example response

{
  "breaks": [
    {
      "ad_break_tracking_events": [
        {
          "beacons": [
            "http://www.adserver.com/breakstart"
          ],
          "event_type": "start"
        }
      ],
      "ads": [
        {
          "duration": 10,
          "id": "7",
          "tracking_events": [
            {
              "beacons": [
                "http://www.adserver.com/breakstart"
              ],
              "event_type": "start"
            }
          ]
        }
      ],
      "unfilled": [
        {
          "duration": 10
        }
      ],
      "break_id": "0",
      "duration": 10,
      "ads_requested": true,
      "url": "profile/mpegts-25-1920-v1/breaks/0/info.json"
    }
  ]
}