Get feedback

Retrieve user feedback from your documentation, including page ratings and code snippet feedback.

GET /v1/analytics/{projectId}/feedback

Get user feedback

cURL

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

200

{
  "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 page feedback, thumbs-only votes, 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, contextual, or thumbs_only 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: Page-level feedback with a text comment. Includes helpful boolean and optional contact email.
• Thumbs-only feedback: A thumbs up or thumbs down vote without a text comment. Shares the same schema as contextual feedback.
• Code snippet feedback: Feedback on a specific code block. Includes code, filename, and lang fields.

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"

source · enum<string>

Filter by feedback source

Available options: code_snippet, contextual, thumbs_only

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

200

application/json

Feedback data with pagination

feedback · object[] · required

List of feedback entries.

Option 1

Option 2

Option 3

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.