GET Audio/Podcasts Top Countries

Overview

---

The following table contains important information about the GET method in regards to retrieving the top countries that visited the platform.

GET Top Countries
Method	GET
URL or Endpoint	/api/v1/projects/projectId/topCountries
Headers	Authorization
Parameters	audioId, podcastId, isPodcast, intervalType, startDate, endDate, items, projectId
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
audioId	Yes	string	Unique identifier of audio
podcastId	No	string	Unique identifier of podcast
isPodcast	No	boolean	A boolean value indicating whether it is a podcast
intervalType	Yes	integer($int32)	Types of intervals for receiving views (e.g., 0 for today)
startDate	No	string($date-time)	The start date you want to receive information for.
endDate	No	string($date-time)	The end date you want to receive information for.
items	No	integer($int32)	Number of items you want to receive
projectId	Yes	string	The id of the project.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "countryName": "Kosovo",
      "countryNr": 1
    }
  ],
  "resultInfo": null,
  "statusCode": 200
}

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

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
countryName	string	Returns the country that visited the platform the most.
browserTypeNr	integer($int32)	Returns the number type of country.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

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:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed