Relatórios

Volume, tempo de resposta, equipe, caixas, IA e créditos.

Os relatórios são só de leitura e usam o escopo relatorios:ler. Dão os mesmos números da tela Relatórios, no fuso da sua organização, e nunca mostram valores em dinheiro: o uso de IA vem só em créditos.

de e ate (AAAA-MM-DD): o período, de até 366 dias. Sem eles, valem os últimos 30 dias.
granularidade: dia (padrão), semana (começa na segunda) ou mes. Vale para volume, tempo de resposta e créditos.
caixa_id: só os números de uma caixa.
formato=csv: planilha em UTF-8 com BOM, cabeçalho e colunas sempre na mesma ordem. Textos que começariam com =, +, - ou @ saem com um apóstrofo na frente, para a planilha não os ler como fórmula.
Cache: a resposta traz ETag. Mande-o em If-None-Match e, se nada mudou, a resposta é 304 sem corpo. Os números mudam a cada mensagem: não guarde por mais de 1 minuto.
Limite próprio: 12 consultas por minuto por chave e 30 por organização (429 limite_relatorios). Se a consulta demorar demais, vem 503 relatorio_demorou: escolha um período menor ou agrupe por semana ou mês.
O tempo de resposta traz a porcentagem respondida em até 1, 5, 15 e 60 minutos.

Endpoints#

Códigos de erro#

Além dos gerais (chave, limite, JSON), estes podem vir em erro.codigo nas rotas daqui. Todos estão em Erros.

Códigos de erro
codigo	O que significa
periodo_longo	Escolha um período de até 366 dias.
periodo_invalido	Período inválido: `de` precisa ser antes de `ate` (AAAA-MM-DD).
granularidade_invalida	granularidade deve ser dia, semana ou mes.
caixa_invalida	Caixa não encontrada nesta organização (veja GET /me).
limite_relatorios	Relatórios têm limite próprio, mais baixo. Espere o tempo de Retry-After.
relatorio_demorou	O relatório demorou demais. Escolha um período menor ou uma granularidade maior (semana ou mes).