mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Reed Barnes
f74260a0ae
* hidden documentation for new analytics API endpoints * Add property descriptions to spec * Align path description with discovery OpenAPI spec Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Align projectId description with other specs * update bearerAuth description --------- Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
25 lines
991 B
Plaintext
25 lines
991 B
Plaintext
---
|
|
openapi: /analytics.openapi.json GET /api/external/v1/analytics/{projectId}/feedback
|
|
keywords: ["analytics", "feedback", "export", "user feedback"]
|
|
---
|
|
|
|
## Usage
|
|
|
|
Use this endpoint to export user feedback collected from your documentation. Feedback includes contextual feedback from page ratings and code snippet feedback.
|
|
|
|
Paginate through results using the `cursor` parameter returned in the response. Continue fetching while `hasMore` is `true`.
|
|
|
|
## Filtering
|
|
|
|
Filter feedback by:
|
|
- **Date range**: Use `dateFrom` and `dateTo` to limit results to a specific time period
|
|
- **Source**: Filter by `code_snippet` or `contextual` feedback types
|
|
- **Status**: Filter by status values like `pending`, `in_progress`, `resolved`, or `dismissed`
|
|
|
|
## Response types
|
|
|
|
The response contains different feedback types based on the source:
|
|
|
|
- **Contextual feedback**: Includes `helpful` boolean and optional `contact` email
|
|
- **Code snippet feedback**: Includes `code`, `filename`, and `lang` fields
|