v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

live events

List live events

Get a list of events that belong to a live channel

get/v2/sites/{site_id}/channels/{channel_id}/events/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

channel_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the live channel

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

Example: title:+a title

Live events can be queried by the following attributes:

created
last_modified
status

sortstring

Allows for sorting results

Example: sort=created:dsc

Sort order can be one of asc, dsc

Live events can be sorted by the following attributes:

created
last_modified
status

Response

Resources successfully retrieved

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,
  "events": [
    {
      "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",
      "master_access": {
        "status": "available",
        "expiration": "2022-11-11T07:50:00+00:00"
      },
      "media_id": "Ny05CEfj",
      "status": "idle"
    }
  ]
}