Analytics APIEndpoints

Returns how many times each event happened in the company

Returns, for each requested event, how many times it happened in the players of the company, or in one player when `player_id` is sent. Dates are read in UTC. Events that did not happen in the period are absent.

POST
/events/total_by_company

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" \  -H "Content-Type: application/json" \  -d '{    "events": [      "started",      "viewed"    ],    "player_id": "64a5c8072e6fd10009828db2",    "start_date": "2026-09-01 00:00:00",    "end_date": "2026-09-30 23:59:59"  }'
[  {    "event": "started",    "total": 1520,    "total_uniq_sessions": 1210,    "total_uniq_device": 1105  },  {    "event": "viewed",    "total": 4310,    "total_uniq_sessions": 3980,    "total_uniq_device": 3502  }]