mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
a6ec4be434
* docs: fix Vale warnings from PRs merged in the last week * docs: mirror Vale style fixes into es/fr/zh translations --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
27 lines
1.3 KiB
Plaintext
27 lines
1.3 KiB
Plaintext
---
|
|
title: "Get assistant conversations"
|
|
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant
|
|
keywords: ["analytics", "assistant", "conversations", "export", "AI"]
|
|
|
|
---
|
|
|
|
## 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)
|
|
- **pageUrl**: Full URL of the documentation page where the conversation started, or `null` if no page path is available. Use this field to attribute conversations to a specific page.
|