Estatísticas usadas pelo painel de headlines
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"]}`.
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/headlines/stats_by_player" \ -H "Content-Type: application/json" \ -d '{ "start_date": "2026-09-01 00:00:00", "end_date": "2026-09-30 23:59:59", "player_id": "64a5c8072e6fd10009828db2", "video_duration": 1200, "pitch_time": 300 }'[ { "number": 1, "views": 140, "plays": 52, "engagement": 0.42, "play_rate": 0.35, "play_over_engagement": 0.147, "pitch": 0.18, "clicks": 12, "conversions": 3, "amount_brl": 59100, "amount_usd": 0, "amount_eur": 0, "conversion_rate": 5.77 }, { "number": 2, "views": 150, "plays": 61, "engagement": 0.37, "play_rate": 0.39, "play_over_engagement": 0.1443, "pitch": 0.15, "clicks": 9, "conversions": 2, "amount_brl": 39400, "amount_usd": 0, "amount_eur": 0, "conversion_rate": 3.28 }]Retorna os cliques de um player para cada dia POST
Retorna os cliques de um player para cada dia do período, no fuso de `timezone`, com os totais do período inteiro. Dias sem cliques vêm com zeros.
Retorna estatísticas de todas as sessões de um player POST
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.