Report overview
GET/api/v1/reports/overview
This month's message and AI usage (organization-wide), contact, opted-in and handed-off conversation counts; the selected period's breakdown by bot, hour and day; a campaign summary. A member only sees data from the bots they can access. Scope: reports:read.
- Scope
reports:read- SDK method
- getReportOverview · get_report_overview
- MCP tool
getReportOverviewread-only
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
daysquery | enum | no | Period in days: 7, 30 or 90; default 307 | 30 | 90, default 30 |
Example request
curl -X GET "https://hiboty.com/api/v1/reports/overview" \
-H "Authorization: Bearer $HIBOTY_API_KEY"Example response (200)
{
"data": {
"days": 1,
"usage": {
"messages": {
"used": 1,
"limit": 1
},
"ai_replies": {
"used": 1,
"limit": 1,
"effective_limit": 1,
"own_key": true
},
"ai_tokens": 1
},
"contacts": {
"total": 1,
"opted_in": 1
},
"conversations": {
"total": 1,
"handoff": 1
},
"bots": [
{
"name": "Hiboty",
"incoming": 1,
"ai": 1,
"agent": 1
}
],
"hourly": [
1
],
"daily": [
{
"date": "string",
"ai": 1,
"agent": 1
}
],
"campaigns": {
"total": 1,
"completed": 1,
"delivered": 1
}
}
}Possible errors
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).401The API key is missing, invalid or revoked (unauthorized).403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.