Returns how far the sessions got, split by a session field
Returns the same distribution as `POST /times/user_engagement`, split by the value of a session field, such as the country or the browser. Only the sessions whose field has one of `values` are counted.
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/times/user_engagement_by_field" \ -H "Content-Type: application/json" \ -d '{ "player_id": "64a5c8072e6fd10009828db2", "field": "country", "values": [ "Brazil" ], "start_date": "2026-09-01 00:00:00", "end_date": "2026-09-30 23:59:59", "timezone": "America/Sao_Paulo" }'[ { "grouped_key": "Brazil", "grouped_values": [ { "timed": 30, "total_users": 58 } ] }]Returns the engagement rate of a player for each day POST
Returns the engagement rate of each day of the period, in `timezone`. Days without sessions come with 0.
Returns how far the sessions got, split by a query parameter of the page POST
Returns the same distribution as `POST /times/user_engagement`, split by the value of a query parameter of the page URL, such as `utm_source`. Only the sessions whose parameter has one of `values` are counted.