Retorna estatísticas de todas as sessões de um player
Retorna os totais das sessões de um player no período: views, plays, finalizações, cliques, engajamento, retenção no pitch e conversões.
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/sessions/stats" \ -H "Content-Type: application/json" \ -d '{ "player_id": "64a5c8072e6fd10009828db2", "start_date": "2026-09-01 00:00:00", "end_date": "2026-09-30 23:59:59", "timezone": "America/Sao_Paulo" }'{ "total_viewed": 200, "total_viewed_session_uniq": 190, "total_viewed_device_uniq": 180, "total_started": 120, "total_started_session_uniq": 115, "total_started_device_uniq": 110, "total_finished": 40, "total_finished_session_uniq": 38, "total_finished_device_uniq": 36, "total_clicked": 50, "total_clicked_session_uniq": 45, "total_clicked_device_uniq": 44, "total_over_pitch": 30, "total_under_pitch": 10, "total_conversions": 5, "overall_conversion_rate": 4.54, "total_amount_usd": 0, "total_amount_brl": 98500, "total_amount_eur": 0, "engagement_rate": "35.27", "over_pitch_rate": "75.25", "play_rate": "61.11"}Estatísticas usadas pelo painel de headlines POST
Retorna um item por headline do teste de headlines do player, com views, plays, engajamento, retenção no pitch, cliques e conversões. As datas são lidas em UTC. Se o player não existir na empresa, a resposta é `400` com `{"error": ["Player could not be found for the current request"]}`.
Retorna estatísticas de todas as sessões de um player por dia POST
Retorna as mesmas estatísticas de `POST /sessions/stats`, um item por dia do período, no fuso de `timezone`. Dias sem sessões vêm com zeros.