Sign in
Restrictions

Retrieves the geographical restrictions applicable to a channel over a given period.

This method:

  • Sets a default period of 30 days back if no 'start' parameter is provided.
  • Sets the end date to "now" if no 'end' parameter is provided.
  • Query the service to obtain the corresponding geographical restrictions.
  • Returns restrictions in the form of an indexed table via a dedicated Resource.
get/1/videos/{channel}/restrictions/geographical

Path parameters

channelinteger required

The unique identifier (ID) of the channel to request.

Query parameters

account_idinteger required

Account identifier

The account identifier

frominteger nullable

Specify the starting date to get Consumption

tointeger nullable

Specify the ending date to get Consumption

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success"
}

Changes

No recorded changes to this endpoint across all 3 revisions of this API.