Skip to main content
GET
Get assistant caller stats

Usage

Use this endpoint to see how many assistant conversations come from each caller type. Each conversation counts once, no matter how many questions it contains. The response breaks down total conversations into:
  • web: Conversations from the documentation site
  • api: Conversations from direct API calls
  • other: Conversations from other sources (for example, integrations, SDKs)
  • total: Sum of all caller types

Filtering

Filter by date range using dateFrom and dateTo parameters. Each conversation counts toward the range where it started.

Rate limits

This endpoint allows 100 requests per organization per hour. All analytics endpoints share this limit.

Authorizations

Authorization
string
header
required

The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.

Path Parameters

projectId
string
required

Your project ID. Can be copied from the API keys page in your dashboard.

Query Parameters

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

Example:

"2024-01-01"

dateTo
string

Date in ISO 8601 or YYYY-MM-DD format. dateTo is an exclusive upper limit. Results include dates before, but not on, the specified date.

Example:

"2024-01-01"

Response

Assistant conversation counts broken down by caller type

web
number
required

Number of assistant conversations started from the web (documentation site).

api
number
required

Number of assistant conversations started from API calls.

other
number
required

Number of assistant conversations started from other sources (e.g., integrations, SDKs).

total
number
required

Total assistant conversations across all caller types.