Get assistant conversations

Returns paginated AI assistant conversation history

GET /v1/analytics/{projectId}/assistant

Get assistant conversations

cURL

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

200

{
  "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, resolution status, 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
• resolutionStatus: Whether the assistant successfully answered the question. Either answered or unanswered. Use this field to track and analyze documentation gaps surfaced by user questions the assistant could not resolve.
• queryCategory: Classification of the query type (if available)

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"

limit · number · default: 100

Max results per page

Required range: 1 <= x <= 1000

cursor · string<ulid>

Pagination cursor (ULID format)

Response

200

application/json

Conversation data with pagination

conversations · object[] · required

List of assistant conversations.

Show child attributes

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.