Analytics APIEndpoints

Returns the totals of the events for each player in a company

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.

POST
/events/total_by_company_players

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/events/total_by_company_players" \  -H "Content-Type: application/json" \  -d '{    "events": [      "started",      "viewed"    ],    "start_date": "2026-01-01",    "end_date": "2026-10-01",    "players_start_date": [      {        "player_id": "64a5c8072e6fd10009828db2",        "start_date": "2026-09-01 00:00:00",        "end_date": "2026-09-30 23:59:59"      }    ]  }'
[  {    "player_id": "64a5c8072e6fd10009828db2",    "event": "started",    "total": 520,    "total_uniq_sessions": 410,    "total_uniq_device": 380  }]