Reports API
How to query Omnifox's conversation, agent, and peak-hour reports via API.
Watch this step in the video · CRM and calendar via API
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
presetorfrom/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/funneland/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/overviewevery morning and sends it to you by email or Slack as a daily digest. - Check
/reports/heatmapbefore 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_idand the date range (presetorfrom/to) are exactly the same ones shown in the panel. from/tohave no effect: if you also sentpresetin the same call, it takes priority and the manual dates are ignored.
Related articles
-
How to connect integrations and external apps
Connect Omnifox with your favorite tools from the integrations catalog in just a few steps.
-
Integrations and API complete guide
Integrations and API in depth, in 30 chapters: API keys, real calls, signed webhooks, n8n, MCP and SDKs, all really working.
-
Connecting Omnifox to Azur, Siigo, Alegra, QuickBooks or another accounting system or ERP
Omnifox doesn't have a native connector for accounting systems or ERPs today. Here's how to connect them anyway with workflows, the HTTP node, n8n, Make, Zapier or the API, with examples.
-
Generate and use API keys and webhooks
Create API keys to access Omnifox programmatically and set up webhooks to receive real-time events.
-
Getting started with integrations (webhook / OAuth / API key)
Connect Omnifox with your other tools: what's available today, what's coming soon, and when to use a webhook, an OAuth connection or an API key.