API reference
Insights API
Reporting for one bot or the whole organisation: activity and audit logs, AI recommendations, visitor intents, satisfaction, website traffic, the credit balance and statement, reports and verifiable conversation archives.
Endpoints
22 operations, each with its parameters, schemas and an example request on its own page.
- get/api/activityWorkspace activity — What has been happening in this workspace, by event.
- patch/api/advice/{recommendation_id}Acknowledge a recommendation — Marks a recommendation acknowledged, done or dismissed.
- post/api/archive/importImport archive — Reads a bundle back and returns it as a viewable report.
- post/api/archive/viewView archive — The same as /archive/import, for a client that already has the JSON.
- get/api/archivesList archives — Which archives have been exported, by whom, and when they expire.
- get/api/audit-logAudit log — Who did what in this workspace.
- get/api/bots/{bot_id}/adviceBot recommendations — The most recent AI recommendations, plus the history behind them.
- get/api/bots/{bot_id}/archiveExport archive — Downloads recent conversations as a portable, verifiable bundle.
- get/api/bots/{bot_id}/dashboardBot dashboard — One bot's dashboard, at whichever depth the reader asked for.
- get/api/bots/{bot_id}/intentsVisitor intents — What visitors wanted, who is worth calling back, and what to fix.
- get/api/bots/{bot_id}/reportBot report — The whole dashboard as a file, in any of five formats.
- get/api/bots/{bot_id}/satisfactionSatisfaction — CSAT and sentiment, with the trend and the conversations behind it.
- get/api/bots/{bot_id}/trafficWebsite traffic — Website traffic, not just widget traffic.
- get/api/creditsCredit balance — The balance, where it is going, and when it runs out.
- get/api/credits/exportExport the credit statement — The statement as a file - the thing somebody sends to their accountant.
- get/api/credits/statementCredit statement — Every draw on the balance, newest first, with a running total.
- get/api/dashboardOrg dashboard — Every bot in the organisation, rolled up and compared.
- get/api/exportsList exports — What this workspace has downloaded.
- get/api/exports/formatsExport formats — What can be downloaded and what each format is for.
- get/api/preferencesGet dashboard preferences
- put/api/preferencesSet dashboard preferences — Remembers which dashboard this person wants.
- get/api/reportOrg report — The organisation-wide report: every bot, rolled up, plus credits.
Authentication
Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.
Objects returned
The models these endpoints send back, with every field. Open one to read it.
Message2 fields
messagestringrequiredokbooleanDefault: true
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.