Returns the totals of the events of a player for each day
Returns, for each requested event, one item per day of the period, in `timezone`, including the days without the event. The counts come as strings.
Authorization
apiToken apiVersion userAgent Access the application and copy your api token, then, just set the header X-Api-Token with it.
In: header
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
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/events/total_by_company_day" \ -H "Content-Type: application/json" \ -d '{ "player_id": "64a5c8072e6fd10009828db2", "events": [ "started", "viewed" ], "start_date": "2026-09-01 00:00:00", "end_date": "2026-09-15 23:59:59", "timezone": "America/Sao_Paulo" }'[ { "event": "started", "events_by_day": [ { "day": "2026-09-01", "total": "104", "total_uniq_device": "88", "total_uniq_session": "93" }, { "day": "2026-09-02", "total": "0", "total_uniq_device": "0", "total_uniq_session": "0" } ] }]Returns the totals of the events for each player in a company POST
Returns, for each player and event, how many times the event happened. Dates are read in UTC. With `players_start_date`, only the players listed there are returned, each one in its own period.
Returns player leaderboards based on video engagement metrics POST
Ranks the players of the company by how many sessions had an event in a period. Several leaderboards, each with its own event, period and size, can be requested in one call. Periods are whole days in `timezone`.