Skip to main content
GET
/
api
/
external
/
v1
/
analytics
/
{projectId}
/
assistant
Get assistant conversations
curl --request GET \
  --url https://api.mintlify.com/api/external/v1/analytics/{projectId}/assistant \
  --header 'Authorization: Bearer <token>'
{
  "conversations": [
    {
      "id": "<string>",
      "timestamp": "<string>",
      "query": "<string>",
      "response": "<string>",
      "sources": [
        {
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "queryCategory": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​
Usage

Use this endpoint to export AI assistant conversation history from your documentation. Each conversation includes the user query, assistant response, sources cited, and query category. Paginate through results using the cursor parameter returned in the response. Continue fetching while hasMore is true.

​
Filtering

Filter conversations by date range using dateFrom and dateTo parameters.

​
Conversation data

Each conversation includes:
  • query: The user’s question
  • response: The assistant’s answer
  • sources: Pages referenced in the response, with title and URL
  • queryCategory: Classification of the query type (if available)

Authorizations

​
Authorization
string
header
required

The Authorization header expects a Bearer token. See the API authentication documentation for details on how to get your API key.

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

Example:

"2024-01-01"

​
limit
number
default:100

Max results per page

Required range: 1 <= x <= 1000
​
cursor
string<ulid>

Pagination cursor (ULID format)

Response

Conversation data with pagination

​
conversations
object[]
required

List of assistant conversations.

​
nextCursor
string | null
required

Cursor to retrieve the next page of results. Null if no more results.

​
hasMore
boolean
required

Whether additional results are available beyond this page.