Retorna rankings de players baseados em métricas de engajamento do vídeo
Classifica os players da empresa por quantas sessões tiveram um evento em um período. Vários rankings, cada um com seu evento, período e tamanho, podem ser pedidos em uma chamada. Os períodos são dias inteiros no fuso de `timezone`.
Authorization
apiToken apiVersion userAgent Acesse a aplicação e copie seu token de API, em seguida, defina o cabeçalho X-Api-Token com ele.
In: header
A versão da API a ser usada. As versões suportadas atualmente são:
- v1: A versão estável atual
Uma requisição sem este cabeçalho, ou com qualquer outro valor, é respondida pela borda com 404 e {"error_msg":"404 Route Not Found"}.
In: header
É obrigatório enviar um User-Agent não vazio identificando sua integração.
Requisições sem ele são rejeitadas na borda antes de chegar à 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 } ] }]Retorna os totais dos eventos de um player para cada dia POST
Retorna, para cada evento pedido, um item por dia do período, no fuso de `timezone`, inclusive os dias sem o evento. As contagens vêm como strings.
Retorna até onde as sessões de um player chegaram no vídeo POST
Retorna, para cada segundo do vídeo, quantas sessões pararam ali (o ponto mais avançado a que chegaram no vídeo), com o tempo médio assistido e a taxa de engajamento. Os itens são uma distribuição, não uma contagem acumulada: para saber quantas sessões chegaram ao segundo T, some o `total_users` de todos os itens cujo `timed` seja T ou maior.