Analytics APIEndpoints

Returns the clicks of a player for each second of the video

Returns how many clicks happened at each second of the video. Seconds without clicks are absent.

POST
/clicks/total_by_company_timed

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/clicks/total_by_company_timed" \  -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",    "timezone": "America/Sao_Paulo"  }'
[  {    "timed": 300,    "total_users": 14  }]