Skip to main content
GET
/
analytics
Get Analytics
curl --request GET \
  --url https://api.getoutbox.ai/analytics/ \
  --header 'Authorization: Bearer <token>'
{
  "main": {},
  "lineChartData": [
    {}
  ],
  "statisticsData": {},
  "monitoring": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-User-Timezone
string

IANA timezone name (e.g. Australia/Perth). Defaults to UTC.

Query Parameters

​
agent
string
default:all

Agent UUID, or all for every agent in scope.

​
end_date
string<date>

ISO date (YYYY-MM-DD). Required when period=custom.

​
period
enum<string>
default:monthly

Predefined time window. Use custom together with start_date/end_date.

Available options:
custom,
daily,
monthly,
weekly,
yearly
​
start_date
string<date>

ISO date (YYYY-MM-DD). Required when period=custom.

​
type
enum<string>
default:all

Filter by agent type. all may auto-resolve to chat or voice if only one type produced threads in the window.

Available options:
all,
chat,
voice

Response

200 - application/json

Aggregated analytics payload.

​
type
enum<string>
required
  • all - all
  • chat - chat
  • voice - voice
Available options:
all,
chat,
voice
​
main
object
required

Top-line totals for the period (conversations, cost, profit, etc.) and percentage deltas vs the previous period.

​
lineChartData
object[]
required

Time-series buckets keyed by hour/day/month depending on period.

​
statisticsData
object
required

Sub-totals broken out by status, agent, etc.

​
monitoring
object
required

Quality-score split: excellent, good, poor with count and percentage.