Get feedback by page

Retrieve user feedback counts aggregated by documentation page, including thumbs up/down ratings and code snippet feedback.

GET /v1/analytics/{projectId}/feedback/by-page

Get feedback by page

cURL

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

200

{
  "feedback": [
    {
      "path": "<string>",
      "thumbsUp": 123,
      "thumbsDown": 123,
      "code": 123,
      "total": 123
    }
  ],
  "hasMore": true
}

Usage

Use this endpoint to export user feedback aggregated by documentation page path. Each entry shows the total feedback count for a page, broken down by type.

Paginate through results using the hasMore flag in the response.

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 data

Each page entry includes:

• path: The documentation page path
• thumbsUp: Count of positive contextual feedback
• thumbsDown: Count of negative contextual feedback
• code: Count of code snippet feedback
• total: Total feedback entries for the page

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"

limit · number · default: 10

Max results per page

Required range: 1 <= x <= 100

source · enum<string>

Filter by feedback source

Available options: code_snippet, contextual

status · string

Comma-separated list of statuses to filter by

Response

200

application/json

Per-page feedback aggregates with pagination flag

feedback · object[] · required

Feedback counts aggregated by documentation page path.

Show child attributes

hasMore · boolean · required

Whether additional results are available beyond this page.