Skip to main content
Mintlify

Search documentation

Type to search this documentation.

On this pageOverview

Get assistant caller stats

GET

/

v1

/

analytics

/

/

assistant

/

caller-stats

Get assistant caller stats

curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/assistant/caller-stats \
  --header 'Authorization: Bearer <token>'
title="200"
{
  "web": 123,
  "api": 123,
  "other": 123,
  "total": 123
}
title="400"
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}
title="500"
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}

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

Filter by date range using dateFrom and dateTo parameters.

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

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.

projectId

string

required

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

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"

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.

⌘I

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu