Devuelve rankings de reproductores basados en métricas de engagement del vídeo
Clasifica los reproductores de la empresa según cuántas sesiones tuvieron un evento en un periodo. Se pueden solicitar varios rankings en una llamada, cada uno con su evento, periodo y tamaño. Los periodos son días completos en la zona horaria de `timezone`.
Authorization
apiToken apiVersion userAgent 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
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
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/events/leaderboard" \ -H "Content-Type: application/json" \ -d '{ "company_id": "2b884cba-0b12-42ce-b3a1-7a3182d414df", "leaderboards": [ { "leaderboard_limit": 10, "start_date": "2026-09-01", "end_date": "2026-10-01", "event": "finished" }, { "leaderboard_limit": 5, "start_date": "2026-09-01", "event": "started" } ], "timezone": "America/Sao_Paulo" }'[ { "leaderboard_name": "leaderboard_10", "event": "finished", "leaderboards": [ { "player_id": "64a5c8072e6fd10009828db2", "total_plays": 100, "uniq_plays": 50, "uniq_device_plays": 25 }, { "player_id": "65fb3c74ab21c70007b3e0dd", "total_plays": 80, "uniq_plays": 40, "uniq_device_plays": 20 } ] }]Devuelve los totales de los eventos de un reproductor de cada día POST
Devuelve, para cada evento solicitado, un elemento por día del periodo, en la zona horaria de `timezone`, incluidos los días sin el evento. Los conteos vienen como strings.
Devuelve hasta dónde llegaron en el vídeo las sesiones de un reproductor POST
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.