Ler os seus dados pela API

Tudo o que a interface mostra é legível por programa, com os mesmos filtros e os mesmos períodos.

Em resumo

Uma API de leitura expõe as suas estatísticas em formato JSON, com uma chave pessoal. Serve para alimentar um painel interno, um relatório automatizado ou uma ferramenta de terceiros.

Obter uma chave

As chaves criam-se a partir do seu perfil. Uma chave dá acesso de leitura a todos os sites da sua conta e pode ser revogada a qualquer momento.

É enviada no cabeçalho de autorização. Não a publique em código executado por um navegador: seria aí legível por qualquer pessoa.

Os pontos de entrada

/api/v1/sites lista os sites acessíveis e os seus identificadores.
/api/v1/stats devolve um painel completo para um site e um período.
/api/v1/realtime devolve os visitantes ativos.

Uma chamada devolve um painel inteiro, mesmo que só queira uma métrica. O débito é limitado: agrupe as suas necessidades numa chamada em vez de as multiplicar.

Filtrar

Os filtros passam-se em parâmetros, sob a forma filters[dimensao]=valor. As dimensões aceites estão listadas na documentação técnica.

Uma dimensão desconhecida é ignorada em silêncio: a resposta chega completa, sem filtro aplicado e sem erro. Verifique o nome exato da dimensão se os seus números parecerem demasiado elevados.

Falta-lhe uma resposta? Escreva-nos. Respondemos nós próprios e completamos este guia.

Fazer uma pergunta