API Reference

Get region data

Retrieves analytics data grouped by geographic regions

GET /region

Retrieves analytics data grouped by geographic regions across all videos.

Detailed Description

Retrieves comprehensive analytics data grouped by geographic regions, showing viewer distribution and engagement metrics across different countries and regions. This endpoint provides insights into global audience reach and regional performance patterns.

HTTP Method & Path

GET /region

Authentication Requirements

  • Security Scheme: PandaAuth (apiKey)
  • Header: Authorization: <your_api_token> (no Bearer prefix)

Parameters

NameInTypeRequiredDescription
AuthorizationheaderstringYesPanda API token (without Bearer prefix)
start_datequerystring (date)NoStart date for analytics data. Format: YYYY-MM-DD (e.g., 2025-01-01)
end_datequerystring (date)NoEnd date for analytics data. Format: YYYY-MM-DD (e.g., 2025-01-01)
granularityquerystringNoData granularity (total, day, hour). Default: total
countryquerystringNoFilter by country (e.g., BR, US, CA)
regionquerystringNoFilter by region (required when granularity=day or hour)

Notes

  • Country codes follow ISO 3166-1 alpha-2 standard (e.g., BR, US, CA)
  • When using granularity=day or granularity=hour, both region and country parameters are required
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!