API de AnalyticsEndpoints

Devuelve hasta dónde llegaron en el vídeo las sesiones de un reproductor

Devuelve, para cada segundo del vídeo, cuántas sesiones se detuvieron allí (el punto más avanzado al que llegaron en el vídeo), con el tiempo promedio visto y la tasa de engagement. Los elementos son una distribución, no un conteo acumulado: para saber cuántas sesiones llegaron al segundo T, suma el `total_users` de todos los elementos cuyo `timed` sea T o mayor.

POST
/times/user_engagement

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Accede a la aplicación y copia tu token de API; luego, solo tienes que definir el encabezado X-Api-Token con él.

In: header

X-Api-Version<token>

La versión de la API que se usará. Las versiones compatibles actualmente son:

  • v1: La versión estable actual

Una solicitud sin este encabezado, o con cualquier otro valor, la responde el edge con 404 y {"error_msg":"404 Route Not Found"}.

In: header

User-Agent<token>

Se requiere un User-Agent no vacío que identifique tu integración. Las solicitudes sin él se rechazan en el edge antes de llegar a la 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" \  -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"  }'
{  "grouped_timed": [    {      "timed": 30,      "total_users": 58    }  ],  "average_watched_time": 900.9,  "engagement_rate": 38.5}