v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB

Analytics API

Get regional data

Retrieves analytics data grouped by geographic regions

get/region

Query parameters

start_datestring

Start date for analytics data

end_datestring

End date for analytics data

granularity'total' | 'day' | 'hour'

Data granularity (total, day, hour)

countrystring

Example:BR

Filter by country (e.g., BR, US, CA)

regionstring

Filter by region (required when granularity=day or hour)

Response

Regional analytics data retrieved successfully

object required

Example response

{
  "BR": {
    "Minas Gerais": {
      "view": 12,
      "play": 4,
      "unique_play": 3,
      "unique_view": 3
    },
    "Paraná": {
      "view": 5,
      "play": 4,
      "unique_play": 2,
      "unique_view": 2
    },
    "Rio Grande do Norte": {
      "view": 3,
      "play": 1,
      "unique_play": 1,
      "unique_view": 2
    }
  }
}