Documentação
Do zero ao primeiro replay, e como ler seus dados por API ou por agente.
1. Instalar
Cole uma linha no <head> de todas as páginas (ou uma vez no tema do site). Cada projeto tem o seu endereço, que o painel mostra em Instalação e chave.
<script async src="https://SEU-COLETOR/dados/ID-DO-PROJETO.js"></script>
Para conferir: navegue por duas páginas e abra Tempo real. Em até um minuto os visitantes devem passar de zero. Se não passarem, veja Saúde da coleta.
2. API de leitura
Todas as rotas ficam em /api/v1, são só de leitura e pedem a chave do projeto (começa com sk_) no cabeçalho X-API-Key. A chave fica no servidor: nunca a coloque em código que roda no navegador. Período por de e ate (data e hora ISO).
curl -H "X-API-Key: sk_..." "https://SEU-COLETOR/api/v1/resumo"
| /resumo | visualizações, visitantes e sessões do período |
| /serie | série no tempo (passo hora ou dia) |
| /agora | visitantes no site agora |
| /paginas | páginas mais vistas |
| /origens | de onde vieram |
| /campanhas | sessões por UTM da primeira página |
| /sessoes | lista de sessões |
| /sessoes/{id} | eventos de uma sessão |
| /sessoes/{id}/replay | blocos de gravação |
| /visitantes/{id} | linha do tempo do visitante |
| /funil | funil por páginas |
| /fluxo | para onde vão depois de cada página |
| /entradas-e-saidas | páginas de entrada e saída |
| /rolagem | até onde cada página é lida |
| /mapa-de-cliques | cliques por página |
| /friccao | cliques de raiva e botões sem resposta |
| /vitals | Web Vitals de visitas reais |
| /eventos | eventos e valor |
| /erros | erros de JavaScript agrupados |
| /receita | receita por canal |
| /roi | ROAS, CAC e lucro com o gasto informado |
| /dispositivos | aparelho, navegador, sistema, país e robôs |
| /coortes | retenção semanal |
| /ciclo-de-vida | fases dos visitantes |
| /retorno | novos e recorrentes |
| /meta | taxa de uma meta por página ou evento |
| /alertas | alertas avaliados |
| /saude-da-coleta | se a coleta está viva |
| /qualidade | qualidade dos dados |
| /insights | leitura de comportamento |
| /briefing | resumo para agentes |
| /perguntar | pergunte aos dados em português (POST) |
| /chaves | listar, criar chave pública e revogar |
| /webhooks | avisos assinados de saída: destinos, teste, segredo, entregas |
| /openapi.json | descrição completa da API |
O formato exato de cada resposta está em /api/v1/openapi.json. Quando um dado não existe, a resposta diz “desconhecido” ou devolve nulo: nunca um zero inventado.
3. Para agentes (MCP)
O mesmo conteúdo da API está disponível como servidor MCP em POST /api/v1/mcp, com a mesma chave. Assim o seu agente pergunta aos dados em vez de você montar relatório.
4. Privacidade
Senhas e campos de formulário são mascarados. Para ocultar um bloco sensível, marque-o no seu HTML. Veja a página de privacidade.