API reference · Insights
Bot report
The whole dashboard as a file, in any of five formats.
- Authentication
- Bearer token
- Retries
- Safe to repeat
- Body
- None
- Version
- 2026-09-03
All five are renderings of one Report object, which is the property that matters: a customer who exports the same period as a spreadsheet and as a PDF and finds two different numbers has learned something about this product that no amount of later accuracy undoes.
advanced by default here, unlike the screen. Somebody who chose to download a file has asked for the data; the mode switch inside the HTML export still lets them read it simply.
Path parameters
bot_idstringrequired
Query parameters
formatstringDefault: html·Pattern: ^(html|xlsx|pdf|csv|json)$
daysintegerDefault: 30·≥ 1 and ≤ 365
modestringDefault: advanced·Pattern: ^(simple|advanced)$
include_usagebooleanDefault: true
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/report" \
-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 Insights endpoints
- get/api/activityWorkspace activity
- patch/api/advice/{recommendation_id}Acknowledge a recommendation
- post/api/archive/importImport archive
- post/api/archive/viewView archive
- get/api/archivesList archives
- get/api/audit-logAudit log
- get/api/bots/{bot_id}/adviceBot recommendations
- get/api/bots/{bot_id}/archiveExport archive
- get/api/bots/{bot_id}/dashboardBot dashboard
- get/api/bots/{bot_id}/intentsVisitor intents
- get/api/bots/{bot_id}/satisfactionSatisfaction
- get/api/bots/{bot_id}/trafficWebsite traffic
- get/api/creditsCredit balance
- get/api/credits/exportExport the credit statement
- get/api/credits/statementCredit statement
- get/api/dashboardOrg dashboard
- get/api/exportsList exports
- get/api/exports/formatsExport formats
- get/api/preferencesGet dashboard preferences
- put/api/preferencesSet dashboard preferences
- get/api/reportOrg report
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.