Getting blackout information for a specific event

Request

To get blackout details for a specific event, send a GET request to:

https://<host>:<port>/metadata/delivery/GLOBAL/btv/blackout_programmes?connection_type=<connection_type>

where connection_type is the type of connection (e.g., 4G).

By default, this returns results for the next 24 hours. To get blackout events for a different period, add start and end parameters (in Unix epoch time). For example:

https://<host>:<port>/metadata/delivery/GLOBAL/btv/blackout_programmes?connection_type=4G&start=1722423600&end=1722510000

Headers

• Authorization: Bearer – bearer token

• Content-Type: application/json

Mandatory arguments

• connection_type – the connection type

Other arguments

• start – the start time of the query period in Unix epoch time. If omitted, the current time is used.

• end – the end time of the query period in Unix epoch time. If omitted, the time 24 hours from now is used.

• page – the page of results to retrieve (only relevant when limit is also specified)

• limit – the number of results to return per page

• cache – true to allow CDN caching or false to prevent CDN caching.
  Note: this just sets or unsets the relevant response headers.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

A successful response includes the blackout events for the specified time period, indicating whether blackout is true or false for each of the following:

• live – the live event itself

• so – start-over

• cu – catch-up, that is, the ability to watch the event after is is broadcast

See also

Metadata Server (MDS) API Documentation