DocsAPI reference

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.

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 ContactReadrequired
    13 fieldsContactRead
    • first_seen_atstring (date-time)required
    • idstringrequired
    • last_seen_atstring (date-time)required
    • visitor_idstringrequired
    • conversation_countinteger

      Default: 0

    • countrystring | null
    • custom_fieldsobject
    • emailstring | null
    • is_leadboolean

      Default: false

    • message_countinteger

      Default: 0

    • namestring | null
    • phonestring | null
    • tagsarray of any
  • pageintegerrequired
  • page_sizeintegerrequired
  • totalintegerrequired
  • has_moreboolean

    Default: false

  • next_cursorstring | null
PaginatedResponse_ConversationRead_6 fields
  • itemsarray of ConversationReadrequired
    20 fieldsConversationRead
    • idstringrequired
    • last_message_atstring (date-time)required
    • started_atstring (date-time)required
    • statusstringrequired
    • visitor_idstringrequired
    • consentstring

      Default: unknown

    • contact_emailstring | null
    • contact_idstring | null
    • contact_namestring | null
    • contact_phonestring | null
    • custom_fieldsobject
    • ended_atstring (date-time) | null
    • is_leadboolean

      Default: false

    • message_countinteger

      Default: 0

    • page_urlstring | null
    • ratinginteger | null
    • resolvedboolean | null
    • sentimentstring | null
    • summarystring | null
    • titlestring | null
  • pageintegerrequired
  • page_sizeintegerrequired
  • totalintegerrequired
  • has_moreboolean

    Default: false

  • next_cursorstring | null
BulkResponse3 fields
  • failedintegerrequired
  • resultsarray of BulkOutcomerequired
    3 fieldsBulkOutcome
    • idstringrequired
    • okbooleanrequired
    • errorstring | null
  • succeededintegerrequired
ConversationDetail25 fields
  • idstringrequired
  • last_message_atstring (date-time)required
  • started_atstring (date-time)required
  • statusstringrequired
  • visitor_idstringrequired
  • consentstring

    Default: unknown

  • contact_emailstring | null
  • contact_idstring | null
  • contact_namestring | null
  • contact_phonestring | null
  • custom_fieldsobject
  • ended_atstring (date-time) | null
  • is_leadboolean

    Default: false

  • message_countinteger

    Default: 0

  • messagesarray of MessageRead
    13 fieldsMessageRead
    • contentstringrequired
    • created_atstring (date-time)required
    • idstringrequired
    • rolestringrequired
    • citationsarray of object | null
    • creditsnumber | null
    • error_codestring | null
    • input_tokensinteger | null
    • is_errorboolean

      Default: false

    • latency_msinteger | null
    • modelstring | null
    • output_tokensinteger | null
    • ttft_msinteger | null
  • page_urlstring | null
  • ratinginteger | null
  • referrerstring | null
  • resolvedboolean | null
  • sentimentstring | null
  • summarystring | null
  • titlestring | null
  • total_creditsnumber

    Default: 0

  • total_input_tokensinteger

    Default: 0

  • total_output_tokensinteger

    Default: 0

Message2 fields
  • messagestringrequired
  • okboolean

    Default: true

Something unclear or missing? Tell us and we’ll fix it.