Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
ssai

List live ad breaks

List all live ad breaks for a media

get/v2/sites/{site_id}/live/{media_id}/ad_breaks/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

media_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the media

Query parameters

pageinteger

Sets the page number for pagination. First page is 1.

page_lengthinteger

Sets the page length (number of items you get in the response) for pagination

If page_length is not specified, the default value will be set.

Default: 10

fromstring

lower bound of the time range

Example:2019-09-25T15:29:11.042095+00:00

lower bound of the time range

tostring

upper bound of the time range

Example:2019-09-25T15:29:11.042095+00:00

upper bound of the time range

Response

Request to list live ad breaks successful

pageinteger

Offset for returned resources

page_lengthinteger

Maximum number of resources to return

totalinteger

Number of resources available before pagination

Example response

{
  "page": 1,
  "page_length": 10,
  "total": 1,
  "ad_breaks": [
    {
      "schema": "https://schema.jwplayer.com/types/thumbnail.json",
      "id": "Ny05CEfj",
      "created": "2019-09-25T15:29:11.042095+00:00",
      "last_modified": "2019-09-25T15:29:11.042095+00:00",
      "metadata": {
        "start_time": "2019-09-25T15:29:11.042095+00:00",
        "duration": 30
      }
    }
  ]
}