Dashboard API
The data behind the dashboard: conversations and contacts — including subject-access export and erasure — per-agent analytics and knowledge gaps, API keys, request logs, plan usage and saved views.
On this page
Endpoints#
21 operations, each with its parameters, schemas and an example request on its own page.
- getAgent analytics/api/agents/{agent_id}/analyticsOverview and daily series for one agent.
- getKnowledge gaps/api/agents/{agent_id}/analytics/gapsQuestions the agent could not answer.
- getAgent insights/api/agents/{agent_id}/analytics/insightsThe three numbers that answer "is it working".
- getList contacts/api/agents/{agent_id}/contactsOne row per person, deduplicated across sessions and devices - unlike /conversations, which is one row per session.
- getExport contacts/api/agents/{agent_id}/contacts/export
- getExport subject data/api/agents/{agent_id}/contacts/{contact_id}/dataEverything held about one person, for a subject access request.
- deleteErase subject data/api/agents/{agent_id}/contacts/{contact_id}/dataArticle 17 erasure, in whichever of the two forms the tenant chooses.
- getList conversations/api/agents/{agent_id}/conversationsOne page of conversations.
- postBulk update conversations/api/agents/{agent_id}/conversations/bulkResolve, reopen or delete a batch of conversations.
- getGet conversation/api/agents/{agent_id}/conversations/{conversation_id}
- getList API keys/api/api-keys
- postCreate API key/api/api-keysCreates a key. The plaintext is returned exactly once and never again - only a peppered hash is stored.
- deleteRevoke API key/api/api-keys/{api_key_id}
- getList request logs/api/logsThis workspace's API traffic, newest first.
- getRequest log summary/api/logs/summaryVolume, error rate, latency and the busiest endpoints over a window.
- getOrg overview/api/overviewThe dashboard home page: cross-agent totals plus plan usage.
- getPlan usage/api/usage
- getList saved views/api/viewsNamed filter sets for the conversation and contact lists.
- postCreate saved view/api/views
- patchUpdate saved view/api/views/{view_id}
- deleteDelete saved view/api/views/{view_id}
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.
PaginatedResponse_ContactRead_6 fields
itemsarray of ContactReadrequired13 fieldsContactRead
first_seen_atstring (date-time)requiredidstringrequiredlast_seen_atstring (date-time)requiredvisitor_idstringrequiredconversation_countintegerDefault: 0
countrystring | nullcustom_fieldsobjectemailstring | nullis_leadbooleanDefault: false
message_countintegerDefault: 0
namestring | nullphonestring | nulltagsarray of any
pageintegerrequiredpage_sizeintegerrequiredtotalintegerrequiredhas_morebooleanDefault: false
next_cursorstring | null
PaginatedResponse_ConversationRead_6 fields
itemsarray of ConversationReadrequired20 fieldsConversationRead
idstringrequiredlast_message_atstring (date-time)requiredstarted_atstring (date-time)requiredstatusstringrequiredvisitor_idstringrequiredconsentstringDefault: unknown
contact_emailstring | nullcontact_idstring | nullcontact_namestring | nullcontact_phonestring | nullcustom_fieldsobjectended_atstring (date-time) | nullis_leadbooleanDefault: false
message_countintegerDefault: 0
page_urlstring | nullratinginteger | nullresolvedboolean | nullsentimentstring | nullsummarystring | nulltitlestring | null
pageintegerrequiredpage_sizeintegerrequiredtotalintegerrequiredhas_morebooleanDefault: false
next_cursorstring | null
BulkResponse3 fields
failedintegerrequiredresultsarray of BulkOutcomerequired3 fieldsBulkOutcome
idstringrequiredokbooleanrequirederrorstring | null
succeededintegerrequired
ConversationDetail25 fields
idstringrequiredlast_message_atstring (date-time)requiredstarted_atstring (date-time)requiredstatusstringrequiredvisitor_idstringrequiredconsentstringDefault: unknown
contact_emailstring | nullcontact_idstring | nullcontact_namestring | nullcontact_phonestring | nullcustom_fieldsobjectended_atstring (date-time) | nullis_leadbooleanDefault: false
message_countintegerDefault: 0
messagesarray of MessageRead13 fieldsMessageRead
contentstringrequiredcreated_atstring (date-time)requiredidstringrequiredrolestringrequiredcitationsarray of object | nullcreditsnumber | nullerror_codestring | nullinput_tokensinteger | nullis_errorbooleanDefault: false
latency_msinteger | nullmodelstring | nulloutput_tokensinteger | nullttft_msinteger | null
page_urlstring | nullratinginteger | nullreferrerstring | nullresolvedboolean | nullsentimentstring | nullsummarystring | nulltitlestring | nulltotal_creditsnumberDefault: 0
total_input_tokensintegerDefault: 0
total_output_tokensintegerDefault: 0
Message2 fields
messagestringrequiredokbooleanDefault: true
Something unclear or missing? Tell us and we’ll fix it.