Get assistant caller stats

Returns a breakdown of assistant query counts by caller type (web, API, and other) for the specified date range.

GET /v1/analytics/{projectId}/assistant/caller-stats

Get assistant caller stats

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/assistant/caller-stats \
  --header 'Authorization: Bearer <token>'

200

{
  "web": 123,
  "api": 123,
  "other": 123,
  "total": 123
}

Usage

Use this endpoint to see how the system distributes assistant queries across different caller types. The response breaks down total queries into:

• web: Queries from the documentation site
• api: Queries from direct API calls
• other: Queries from other sources (for example, integrations, SDKs)
• total: Sum of all query types

Filtering

Filter by date range using dateFrom and dateTo parameters.

Authorizations

Authorization · string · header · required

The Authorization header expects a Bearer token. Use an admin API key (prefixed with mint_). 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

200

application/json

Assistant query counts broken down by caller type

web · number · required

Number of assistant queries originating from the web (documentation site).

api · number · required

Number of assistant queries originating from API calls.

other · number · required

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

total · number · required

Total assistant queries across all caller types.