Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
SSAI

Ad config schedule

Returns an ad config schedule in JSON or XML format

get/v2/sites/{site_id}/ad_configs/{ad_config_id}/schedule.{ad_config_extension}

Path parameters

site_idstring required

Property or site ID that owns a piece of media

ad_config_idstring required

Unique identifier of the ad config

ad_config_extension'json' | 'xml' required

Delivery format of the ad config schedule

Possible Values:

  • xml: XML format
  • json: JSON format

Query parameters

media_idstring

Eight-character, alphanumeric ID that uniquely identifies the media

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

For XML requests, this ID is required. For JSON requests, it is optional,

and generic ad configuration timings will be returned if omitted.

Response

Ad config schedule in the desired format

idstring

Identifier for the ad config that can take one of the following forms:

  • Without individual timings: An 8-character, alphanumeric value, such as a1b2c3d4
  • With individual timings: A 17-character value consisting of the ad config and timing IDs separated by a hyphen, such as a1b2c3d4-z0y9x8w7
default_time_between_adsstring

Default time between ads based on the ad config

preroll_urlstring

URL for preroll ads

midroll_urlstring

URL for midroll ads