Get assistant conversations
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
answeredorunanswered. 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
nullif no page path is available. Use this field to attribute conversations to a specific page.
Rate limits
This endpoint allows 100 requests per organization per hour. All analytics endpoints share this limit.
Was this page helpful?Suggest editsRaise issue