InícioGuiasReferência da API
API de AnalyticsEndpoints

Retorna o conjunto completo de métricas para até 2 players de um teste A/B

Retorna, em uma única resposta, o conjunto completo de métricas de analytics para até 2 players de um teste A/B: views, plays, finishes, clicks, conversões com receita em USD/BRL/EUR, engagement, pitch audience e pitch retention, além das taxas derivadas de play rate, conversion rate e receita por visitante (RPV). O `start_date` de cada item é opcional — quando ausente, usa como padrão o `started_at` do próprio player (da lista `players` do comparison group) e, se ele também estiver nulo, o `started_at` do teste A/B. Quando `end_date` é omitido, o resultado considera até o momento atual.

POST
/comparison_groups/stats

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

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

application/json

application/json

curl -X POST "https://example.com/comparison_groups/stats" \  -H "Content-Type: application/json" \  -d '{    "comparison_group_id": "699f9683dfeab82d6246e13b",    "items": [      {        "player_id": "699f92f01dd8bb9e2b6aab3a",        "start_date": "2026-02-26 00:41:00"      },      {        "player_id": "699f9363c4b02ade5c5f1881",        "start_date": "2026-02-26 00:41:00"      }    ],    "events": [      "started",      "viewed",      "finished"    ]  }'
{  "comparison_group": {    "id": "string",    "name": "string",    "player_ids": [      "string"    ],    "started_at": "string",    "finished_at": "string"  },  "stats": [    {      "player_id": "string",      "pitch_time": 0,      "video_duration": 0,      "views": {        "total": 0,        "total_uniq_sessions": 0,        "total_uniq_device": 0      },      "plays": {        "total": 0,        "total_uniq_sessions": 0,        "total_uniq_device": 0      },      "finishes": {        "total": 0,        "total_uniq_sessions": 0,        "total_uniq_device": 0      },      "clicks": {        "total": 0,        "total_uniq_sessions": 0,        "total_uniq_device": 0      },      "conversions": {        "total": 0,        "total_uniq_sessions": 0,        "total_uniq_device": 0,        "total_amount_usd": 0,        "total_amount_brl": 0,        "total_amount_eur": 0      },      "engagement": {        "average_watched_time": 0,        "engagement_rate": 0,        "grouped_timed": [          {            "timed": 0,            "total_users": 0          }        ]      },      "pitch_audience": 0,      "pitch_retention_rate": 0,      "play_rate": 0,      "conversion_rate": 0,      "rpv_usd": 0,      "rpv_brl": 0,      "rpv_eur": 0    }  ]}

Lista os testes A/B (comparison groups) cadastrados na conta autenticada POST

Retorna todos os testes A/B cadastrados para a empresa, incluindo os players participantes (com suas respectivas porcentagens de tráfego) e as datas de início/fim de cada teste. Resultados ordenados pela data de criação (mais recentes primeiro). Use os filtros opcionais `start_date`/`end_date` para restringir o resultado pelo `created_at` do comparison group.

Retorna o uso atual da cota da API para a empresa autenticada GET

Retorna o uso e os limites atuais da cota da empresa — uma entrada por janela de cota, como por minuto ou por dia. Todas as API keys da empresa compartilham essa cota. Use este endpoint para se auto-limitar antes de disparar requisições analíticas pesadas. Observações: - Quando uma métrica não tem limite, a resposta usa `limit: null` e `remaining: null` para você não dividir por zero. - Quando a empresa não tem cota, `quotas` é uma lista vazia. - Uma única chamada à API pode contar como mais de uma query contra `max_queries_per_minute`, então o contador `queries` pode subir mais rápido que a sua taxa real de requisições. A resposta inclui `queries.note` para sinalizar isso quando há um limite ativo. O `read_bytes` reflete o volume de dados efetivamente lido e é o sinal mais confiável para dimensionar o seu uso. - O próprio endpoint conta como 1 query contra `max_queries_per_minute`.