🇪🇸 Español 🇬🇧 English 🇧🇷 Português

API de Relatórios

Como consultar via API os relatórios de conversas, agentes e horários de pico do Omnifox.

Jul 11, 2026

A API de Relatórios dá acesso às mesmas métricas que você vê na seção Relatórios do painel, para alimentar seu próprio dashboard de BI ou exportá-las para uma planilha periodicamente.

Requisitos

  • Token Bearer do workspace.
  • Um intervalo de datas, definido com preset ou from/to.

Endpoints principais

  • GET /api/v1/reports/overview — resumo geral (volume, tempos de resposta, resolução).
  • GET /api/v1/reports/conversations — métricas de conversas por canal/status.
  • GET /api/v1/reports/agents — desempenho por agente (atribuídas, encerradas, tempo de primeira resposta).
  • GET /api/v1/reports/heatmap — mapa de calor do volume de mensagens por hora/dia, útil para dimensionar turnos.
  • GET /api/v1/crm/reports/funnel e /forecast — relatórios específicos do CRM (veja o artigo da API do CRM).

Parâmetros comuns a todos os relatórios

Parâmetro Descrição
workspace_id Workspace a consultar (opcional; usa o do token atual)
preset Intervalo predefinido: today, yesterday, 7d, 30d, 90d, this_month, last_month
from / to Intervalo manual YYYY-MM-DD (ignorado se preset for enviado)

Exemplo: desempenho de agentes nos últimos 30 dias

curl -X GET "https://app.omnifox.io/api/v1/reports/agents?preset=30d" \
  -H "Authorization: Bearer SEU_TOKEN"

Dicas

  • Programe uma tarefa (cron, n8n, Zapier) que chame /reports/overview toda manhã e envie por e-mail ou Slack como resumo diário.
  • Consulte /reports/heatmap antes de redesenhar turnos de agentes: mostra em quais horários realmente entra mais volume.

Solução de problemas

  • Os números não batem com o que aparece na tela: confira se workspace_id e o intervalo de datas (preset ou from/to) são exatamente os mesmos que você está vendo no painel.
  • from/to não fazem efeito: se você também enviou preset na mesma chamada, ele tem prioridade e as datas manuais são ignoradas.
Isso foi útil?

Artigos relacionados