Skip to main content

GET Top Countries

Overview


The following table contains important information about the GET method for retrieving the top countries in video analytics.

GET Top Countries
MethodGET
URL or Endpoint/api/v2/projects/projectId/analytics/topCountries
HeadersAuthorization
ParametersvideoId, isLive, intervalType, startDate, endDate, items, projectId
BodyNot Applicable

The following table describes the URL parameter for projectId:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique identifier for the project.

The table below provides details about each query parameter:

Parameter NameMandatoryTypeDescription
videoIdNostringUnique identifier of the video.
isLiveNobooleanA boolean indicating whether the video is live.
intervalTypeNointeger($int32)The type of interval for the analytics data.
startDateNostring($date-time)The start date for the analytics data you wish to retrieve.
endDateNostring($date-time)The end date for the analytics data you wish to retrieve.
itemsNointeger($int32)The number of top countries to retrieve.
projectIdYesstringThe unique identifier for the project.

Request Body

This GET request does not contain a request body.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"topCountries": [
{
"country": "United States",
"viewers": 1000
},
{
"country": "Czech",
"viewers": 900
}
]
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successbooleanIndicates whether the request was successful.
errorsarray[]A list of errors that occurred during the request.
messagesarray[]A list of messages returned by the backend.
resultarray[Object]An array containing the analytics result data.
countrystringThe name of the country.
viewersinteger($int32)The number of viewers from that country.
resultInfostringAdditional information about the result.
statusCodeinteger($int32)The HTTP status code of the response.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Result Not Found
  • 500: Internal Server Error
  • 503: Backend Fetch Failed