List all players
Returns the players of the company of the API key, with the duration of their video and their pitch time. Deleted players are not listed.
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
Query Parameters
Lists only the players created at or after this moment, YYYY-MM-DD HH:MM:SS, read in timezone.
Lists only the players created at or before this moment, YYYY-MM-DD HH:MM:SS, read in timezone.
IANA time zone in which the dates are read, such as America/Sao_Paulo. Defaults to UTC.
Filter players by name. Search is case-insensitive (including non-ASCII characters such as É/é). Special characters %, _, \, and brackets are matched literally — for example name=[campaign_1] returns only players whose names contain that exact tag. Surrounding whitespace is trimmed before matching; the trimmed value must be between 3 and 128 characters.
3 <= length <= 128How name is matched. contains (default) matches anywhere in the name; starts_with and ends_with anchor to the beginning or end; exact requires a full case-insensitive match. Sending name_match without name returns 400.
"contains"Value in
- "contains"
- "starts_with"
- "ends_with"
- "exact"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/players/list?start_date=2026-01-01+00%3A00%3A00&end_date=2026-09-30+23%3A59%3A59&timezone=America%2FSao_Paulo&name=%5Bcampaign_1%5D&name_match=starts_with"[ { "id": "64a5c8072e6fd10009828db2", "name": "Sales video", "pitch_time": 300, "duration": 1200, "created_at": "2026-01-23 21:54:39" }]Statistics used by the turbo dashboard POST
Returns one item per Turbo speed of the player, with views, plays, engagement, pitch retention, clicks and conversions. Dates are read in UTC. If the player does not exist in the company, the response is `400` with `{"error": ["Player could not be found for the current request"]}`.
List all custom metrics of a player POST
Returns the retention custom metrics of a player and, for each one, how many sessions reached the second it marks.