InícioGuiasReferência da API
API de AnalyticsEndpoints

Listar todos os players

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.

GET
/players/list

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Acesse a aplicação e copie seu token de API, em seguida, defina o cabeçalho X-Api-Token com ele.

In: header

X-Api-Version<token>

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

User-Agent<token>

É 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

Query Parameters

start_date?string

Lista só os players criados a partir deste momento, YYYY-MM-DD HH:MM:SS, lido no fuso de timezone.

end_date?string

Lista só os players criados até este momento, YYYY-MM-DD HH:MM:SS, lido no fuso de timezone.

timezone?string

Fuso horário IANA em que as datas são lidas, como America/Sao_Paulo. Padrão: UTC.

name?string

Filtra players por nome. A busca é case-insensitive (inclusive para caracteres não-ASCII como É/é). Caracteres especiais %, _, \ e colchetes são tratados como literais — por exemplo, name=[campaign_1] retorna apenas players cujo nome contém exatamente essa tag. Espaços nas pontas são removidos antes da busca; o valor após o trim deve ter entre 3 e 128 caracteres.

Length3 <= length <= 128
name_match?string

Como o name é comparado. contains (padrão) procura em qualquer posição do nome; starts_with e ends_with ancoram no início ou no final; exact exige correspondência completa case-insensitive. Enviar name_match sem name retorna 400.

Default"contains"

Value in

  • "contains"
  • "starts_with"
  • "ends_with"
  • "exact"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/players/list?start_date=2026-01-01+00%3A00%3A00&end_date=2026-09-30+23%3A59%3A59&timezone=America%2FSao_Paulo&name=%5Bcampaign_1%5D&name_match=starts_with"
[  {    "id": "64a5c8072e6fd10009828db2",    "name": "Sales video",    "pitch_time": 300,    "duration": 1200,    "created_at": "2026-01-23 21:54:39"  }]

Estatísticas usadas pelo painel do Turbo POST

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"]}`.

Lista todas as métricas personalizadas de um player POST

Retorna as métricas personalizadas de retenção de um player e, para cada uma, quantas sessões chegaram ao segundo que ela marca.