Returns the engagement rate of a player for each day
Returns the engagement rate of each day of the period, in `timezone`. Days without sessions come with 0.
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_day" \ -H "Content-Type: application/json" \ -d '{ "player_id": "64a5c8072e6fd10009828db2", "video_duration": 3600, "start_date": "2026-09-01 00:00:00", "end_date": "2026-09-30 23:59:59", "timezone": "America/Sao_Paulo" }'[ { "date": "2026-09-01", "engagement_rate": 23.4 }]Returns how far the sessions of a player got in the video POST
Returns, for each second of the video, how many sessions stopped there (their furthest point in the video), with the average watched time and the engagement rate. The items are a distribution, not a cumulative count: to get how many sessions reached second T, add the `total_users` of every item whose `timed` is T or greater.
Returns how far the sessions got, split by a session field POST
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.