HomeGuidesAPI reference
Analytics APIEndpoints

Returns statistics grouped by a specified field

Returns the same statistics as `POST /sessions/stats`, one item per value of a session field, such as the browser or the country.

POST
/sessions/stats_by_field

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Access the application and copy your api token, then, just set the header X-Api-Token with it.

In: header

X-Api-Version<token>

The API version to use. Currently supported versions are:

  • v1: The current stable version

A request without this header, or with any other value, is answered by the edge with 404 and {"error_msg":"404 Route Not Found"}.

In: header

User-Agent<token>

A non-empty User-Agent identifying your integration is required. Requests without it are rejected at the edge before reaching the API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sessions/stats_by_field" \  -H "Content-Type: application/json" \  -d '{    "player_id": "64a5c8072e6fd10009828db2",    "start_date": "2026-09-01 00:00:00",    "end_date": "2026-09-30 23:59:59",    "field": "browser",    "video_duration": 3600,    "timezone": "America/Sao_Paulo",    "pitch_time": 300  }'
[  {    "grouped_field": "Chrome",    "total_viewed": 200,    "total_viewed_session_uniq": 190,    "total_viewed_device_uniq": 180,    "total_started": 120,    "total_started_session_uniq": 115,    "total_started_device_uniq": 110,    "total_finished": 40,    "total_finished_session_uniq": 38,    "total_finished_device_uniq": 36,    "total_clicked": 50,    "total_clicked_session_uniq": 45,    "total_clicked_device_uniq": 44,    "total_over_pitch": 30,    "total_under_pitch": 10,    "total_conversions": 5,    "overall_conversion_rate": 4.54,    "total_amount_usd": 0,    "total_amount_brl": 98500,    "total_amount_eur": 0,    "engagement_rate": "35.27",    "over_pitch_rate": "75.25",    "play_rate": "61.11"  }]

Returns statistics of all sessions of a player by day POST

Returns the same statistics as `POST /sessions/stats`, one item per day of the period, in `timezone`. Days without sessions come with zeros.

Returns statistics grouped by a specified field and by day POST

Returns the same statistics as `POST /sessions/stats_by_field`, also split by day, in `timezone`.