Estatísticas usadas pelo painel do Turbo
Retorna um item por velocidade do Turbo 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/turbo/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 }'[ { "speed": 1, "views": 150, "plays": 60, "engagement": 0.38, "pitch": 0.21, "clicks": 9, "conversions": 2, "amount_brl": 39400, "amount_usd": 0, "amount_eur": 0, "conversion_rate": 3.51 }, { "speed": 1.2, "views": 148, "plays": 57, "engagement": 0.41, "pitch": 0.24, "clicks": 11, "conversions": 3, "amount_brl": 59100, "amount_usd": 0, "amount_eur": 0, "conversion_rate": 5.56 }]Conta os parâmetros de consulta registrados para um player POST
Retorna quantas vezes cada parâmetro de consulta da URL da página foi registrado para o player, como `utm_source`, `utm_campaign`, `src` ou `sck`. Qualquer parâmetro de consulta é contado, não só UTMs.
Listar todos os players GET
Retorna os players da empresa da API key, com a duração do vídeo e o tempo de pitch de cada um. Players excluídos não são listados.