API reference · Dashboard
Bot analytics
Overview and daily series for one bot.
- Authentication
- Bearer token
- Retries
- Safe to repeat
- Body
- None
- Version
- 2026-09-03
Carries an ETag, because this is the panel a dashboard polls. A client that revalidates gets a 304 and no body at all - which on a 90-day series is kilobytes per poll, and on a phone is the difference between a refresh that feels instant and one that does not.
Path parameters
bot_idstringrequired
Query parameters
date_fromstring (date-time) | nulldate_tostring (date-time) | nulldaysintegerDefault: 30·≥ 1 and ≤ 365
Responses
- 200OKapplication/json
any
5 response headers
- RateLimit-Limit
Requests permitted in the current window.
- RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
- RateLimit-Reset
Seconds until the current window resets.
- X-API-Version
The dated version of the API contract that served this response, e.g.
2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.- X-Request-ID
Quote this in a support request to identify the call.
- 422Validation error
The shared error envelope, served as
application/problem+jsonwitherror.codeset to validation_error. Its details name each field that failed and why.
Example request
curl "https://api.integrable.cloud/api/bots/$BOT_ID/analytics" \
-H "Authorization: Bearer $INTEGRABLE_API_KEY"Set INTEGRABLE_API_KEY and the path variables first. The same call from the TypeScript or Python SDK takes the same fields.
Example response
"string"Generated from the schema above — the shape is exact, the values are placeholders.
Errors
Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:
validation_error· 422 — The payload was well-formed JSON but failed schema validation.unauthenticated· 401 — The request carried no API key, or one the API could not verify.forbidden· 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.rate_limited· 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-bot limit on top.
More Dashboard endpoints
- get/api/api-keysList API keys
- post/api/api-keysCreate API key
- delete/api/api-keys/{api_key_id}Revoke API key
- get/api/bots/{bot_id}/analytics/gapsKnowledge gaps
- get/api/bots/{bot_id}/analytics/insightsBot insights
- get/api/bots/{bot_id}/contactsList contacts
- get/api/bots/{bot_id}/contacts/exportExport contacts
- get/api/bots/{bot_id}/contacts/{contact_id}/dataExport subject data
- delete/api/bots/{bot_id}/contacts/{contact_id}/dataErase subject data
- get/api/bots/{bot_id}/conversationsList conversations
- post/api/bots/{bot_id}/conversations/bulkBulk update conversations
- get/api/bots/{bot_id}/conversations/{conversation_id}Get conversation
- get/api/logsList request logs
- get/api/logs/summaryRequest log summary
- get/api/overviewOrg overview
- get/api/usagePlan usage
- get/api/viewsList saved views
- post/api/viewsCreate saved view
- patch/api/views/{view_id}Update saved view
- delete/api/views/{view_id}Delete saved view
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.