List all custom metrics of a player
Returns the retention custom metrics of a player and, for each one, how many sessions reached the second it marks.
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/custom_metrics/list" \ -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" }'[ { "id": "685acdfa39be67017b9be72d", "name": "Custom Metric 1", "time": 600, "sequential_number": 1, "engagement_rate": 18.18, "total_users": 55, "users_above": 10 }]List all players GET
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.
List the AB tests (comparison groups) registered for the authenticated company POST
Returns every AB test registered for the company, with the players enrolled in each test (including their traffic percentages) and the test start/finish timestamps. Results are ordered by creation date (newest first). Use the optional `start_date`/`end_date` filters to narrow results by the comparison group `created_at`.