Skip to main content
GET
/
api
/
external
/
v1
/
analytics
/
{projectId}
/
feedback
Get user feedback
curl --request GET \
  --url https://api.mintlify.com/api/external/v1/analytics/{projectId}/feedback \
  --header 'Authorization: Bearer <token>'
{
  "feedback": [
    {
      "id": "<string>",
      "path": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "source": "code_snippet",
      "status": "pending"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​
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

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"

​
source
enum<string>

Filter by feedback source

Available options:
code_snippet,
contextual
​
status
string

Comma-separated list of statuses to filter by

​
limit
number
default:50

Max results per page

Required range: 1 <= x <= 100
​
cursor
string

Pagination cursor

Response

Feedback data with pagination

​
feedback
object[]
required

List of feedback entries.

​
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.