v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
broadcast live

List Broadcast Live streams

List all Broadcast Live streams for a site

get/v2/sites/{site_id}/live/broadcast/streams/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

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

qstring

Allows for querying results

Live streams can be queried by the following attributes:

  • created
  • id
  • last_modified
  • playout_availability
  • status
  • stream_start
  • title
  • drm
sortstring

Allows for sorting results

Example: sort=created:dsc

Sort order can be one of asc, dsc

Live streams can be sorted by the following attributes:

  • created
  • last_modified
  • playout_availability
  • status
  • stream_start
  • title
  • drm

Response

Success

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,
  "items": {
    "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"
  }
}