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

Reports API

How to query Omnifox's conversation, agent, and peak-hour reports via API.

Jul 11, 2026

The Reports API gives you access to the same metrics you see in the panel's Reports section, so you can feed your own BI dashboard or export them to a spreadsheet on a schedule.

Requirements

  • A Bearer token for the workspace.
  • A date range, set either with preset or from/to.

Main endpoints

  • GET /api/v1/reports/overview — general summary (volume, response times, resolution).
  • GET /api/v1/reports/conversations — conversation metrics by channel/status.
  • GET /api/v1/reports/agents — per-agent performance (assigned, closed, first-response time).
  • GET /api/v1/reports/heatmap — message-volume heatmap by hour/day, useful for planning shifts.
  • GET /api/v1/crm/reports/funnel and /forecast — CRM-specific reports (see the CRM API article).

Parameters shared by every report

Parameter Description
workspace_id Workspace to query (optional; defaults to the token's current one)
preset Predefined range: today, yesterday, 7d, 30d, 90d, this_month, last_month
from / to Manual YYYY-MM-DD range (ignored if preset is sent)

Example: agent performance over the last 30 days

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

Tips

  • Schedule a job (cron, n8n, Zapier) that calls /reports/overview every morning and sends it to you by email or Slack as a daily digest.
  • Check /reports/heatmap before redesigning agent shifts — it shows exactly which hours actually get the most volume.

Troubleshooting

  • Numbers don't match what you see on screen: make sure workspace_id and the date range (preset or from/to) are exactly the same ones shown in the panel.
  • from/to have no effect: if you also sent preset in the same call, it takes priority and the manual dates are ignored.
Was this helpful?

Related articles