Get feedback

GET

/

v1

/

analytics

/

/

feedback

Get user feedback

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

{
  "feedback": [
    {
      "id": "<string>",
      "path": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "source": "code_snippet",
      "status": "pending",
      "helpful": true,
      "contact": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}

Use this endpoint to export user feedback collected from your documentation. Feedback includes contextual feedback from page ratings, code snippet feedback, and agent feedback. Paginate through results using the cursor parameter returned in the response. Continue fetching while hasMore is true.

Filter feedback by:

• Date range: Use dateFrom and dateTo to limit results to a specific time period
• Source: Filter by code_snippet, contextual, or agent feedback types
• Status: Filter by status values like pending, in_progress, resolved, or dismissed

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
• Agent feedback: Includes a comment with the agent’s feedback text and the path of the page it relates to

This endpoint allows 100 requests per organization per hour. All analytics endpoints share this limit.

Authorization

string

header

required

The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.

projectId

string

required

Your project ID. Can be copied from the API keys page in your dashboard.

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,

agent,

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

Feedback data with pagination

feedback

object[]

required

List of feedback entries.

Returned when source is contextual. Includes whether the user found the page helpful and an optional contact email.

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.

⌘I