Get User Feedback

Export user feedback collected from your documentation

GET /v1/analytics/{projectId}/feedback

cURL

curl -X GET "https://api.mintlify.com/v1/analytics/your_project_id/feedback?dateFrom=2024-01-01&limit=50" \
  -H "Authorization: Bearer mint_your_api_key_here"

200 Response

{
  "feedback": [
    {
      "id": "fb_abc123",
      "path": "/getting-started",
      "comment": "This section was very helpful!",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "source": "contextual",
      "status": "resolved",
      "helpful": true,
      "contact": "[e-mail]"
    },
    {
      "id": "fb_def456",
      "path": "/api/examples",
      "comment": "This code doesn't work with the latest version",
      "createdAt": "2024-01-16T14:22:00.000Z",
      "source": "code_snippet",
      "status": "pending",
      "code": "const example = require('example');",
      "filename": "index.js",
      "lang": "javascript"
    }
  ],
  "nextCursor": "cursor_xyz789",
  "hasMore": true
}

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.

Authentication

Requires an admin API key (prefixed with mint_). 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. Filter results to include feedback from this date onwards.

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-31

source · string

Filter by feedback source. Possible values: code_snippet, contextual.

status · string

Comma-separated list of statuses to filter by. Possible values: pending, in_progress, resolved, dismissed.

Example: pending,in_progress

limit · number · default: 50

Max results per page. Minimum: 1, Maximum: 100.

cursor · string

Pagination cursor from the previous response’s nextCursor field.

Response

feedback · array

List of feedback entries.

Show Feedback object

id · string

Unique feedback identifier.

path · string

The path or URL to the source document.

comment · string

Text of the user’s feedback comment.

createdAt · string

Timestamp when the feedback was submitted.

source · string

Where the feedback originated. code_snippet is feedback on a code block, contextual is page-level feedback.

status · string

Current review status of the feedback. Possible values: pending, in_progress, resolved, dismissed.

helpful · boolean

Whether the user found the content helpful (contextual feedback only).

contact · string

Email address the user provided for follow-up (contextual feedback only).

code · string

The code snippet the feedback relates to (code snippet feedback only).

filename · string

Filename associated with the code snippet (code snippet feedback only).

lang · string

Programming language of the code snippet (code snippet feedback only).

nextCursor · string

Cursor to retrieve the next page of results. Null if no more results.

hasMore · boolean

Whether additional results are available beyond this page.

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

cURL

curl -X GET "https://api.mintlify.com/v1/analytics/your_project_id/feedback?dateFrom=2024-01-01&limit=50" \
  -H "Authorization: Bearer mint_your_api_key_here"

200 Response

{
  "feedback": [
    {
      "id": "fb_abc123",
      "path": "/getting-started",
      "comment": "This section was very helpful!",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "source": "contextual",
      "status": "resolved",
      "helpful": true,
      "contact": "[e-mail]"
    },
    {
      "id": "fb_def456",
      "path": "/api/examples",
      "comment": "This code doesn't work with the latest version",
      "createdAt": "2024-01-16T14:22:00.000Z",
      "source": "code_snippet",
      "status": "pending",
      "code": "const example = require('example');",
      "filename": "index.js",
      "lang": "javascript"
    }
  ],
  "nextCursor": "cursor_xyz789",
  "hasMore": true
}