Sign in

v1

latestOpenAPI 3.0.32026-07-13401683.8 KB
Spot Insertions

Returns the spot insertions matching the query parameters.

get/api/v2/spotinsertions

Query parameters

pageStartinteger

The start page of the results to return. The first item is indexed at 0.

pageSizeinteger

The number of items to return. Must be between 0 and 500, inclusive.

orderById'asc' | 'desc'

The sort order of the list of spot insertions, based on ID. If unspecified, the spot insertions are returned in random order. If using paging to iterate through the results, sort order should be specified.

Response

The spot insertions matching the query parameters

idinteger

The unique ID of the spot insertion. Generated at creation.

programIdinteger required

The ID of the program for the spot insertion.

broadcastServiceIdinteger required

The ID of the broadcast service for the spot insertion.

customerIdinteger

The ID of the customer who owns the spot insertion. Set to the logged-in customer at creation.

cuestring required

The cue that triggers the spot insertion.

durationinteger required

The duration of the spot insertion.

spotsinteger[] required

The ordered list of spot IDs to play.

startDatestring date required

The date the spot insertion can start in yyyyMMdd format. The time will be set to midnight Eastern Time.

endDatestring date required

The date the spot insertion ends in yyyyMMdd format. The time will be set to midnight Eastern Time.

createdDatestring date-time

The date and time the spot insertion was created in ISO 8601 format. Generated at creation.

Example response

[
  {
    "cue": "S:000_SPOT",
    "startDate": "2020-01-31",
    "endDate": "2020-01-31"
  }
]