API de Relatórios
Como consultar via API os relatórios de conversas, agentes e horários de pico do Omnifox.
Veja este passo no vídeo · CRM e calendário pela API
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
presetoufrom/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/funnele/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/overviewtoda manhã e envie por e-mail ou Slack como resumo diário. - Consulte
/reports/heatmapantes 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_ide o intervalo de datas (presetoufrom/to) são exatamente os mesmos que você está vendo no painel. from/tonão fazem efeito: se você também envioupresetna mesma chamada, ele tem prioridade e as datas manuais são ignoradas.
Artigos relacionados
-
Como conectar integrações e apps externos
Conecte o Omnifox às suas ferramentas favoritas a partir do catálogo de integrações em poucos passos.
-
Integrar o Omnifox com Azur, Siigo, Alegra, QuickBooks ou outro sistema contábil ou ERP
O Omnifox não tem hoje um conector nativo com sistemas contábeis ou ERP. Veja como fazer essa conexão mesmo assim com fluxos de trabalho, o nó HTTP, n8n, Make, Zapier ou a API, com exemplos.
-
Guia completo de integrações e API
Integrações e API a fundo, em 30 capítulos: chaves de API, chamadas reais, webhooks assinados, n8n, MCP e SDKs, tudo funcionando de verdade.
-
Gerar e usar API keys e webhooks
Crie chaves de API para acessar o Omnifox por código e configure webhooks para receber eventos em tempo real.
-
Introdução às integrações (webhook / OAuth / chave de API)
Conecte o Omnifox às suas outras ferramentas: o que está disponível hoje, o que chega em breve e quando usar um webhook, uma conexão OAuth ou uma chave de API.