Get feedback by page

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

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

Get feedback grouped 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 get an overview of feedback volume across your documentation pages. Results are aggregated per page path and sorted by total feedback count in descending order.

Check the hasMore field in the response to determine if additional pages of results are available. Increase the limit parameter to retrieve more results per request.

Filtering

Filter feedback aggregates 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 fields

Each item in the response represents a documentation page and includes:

• thumbsUp: Number of positive (helpful) contextual ratings
• thumbsDown: Number of negative (not helpful) contextual ratings
• code: Number of code snippet feedback entries
• total: Combined count of all feedback types 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"

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: 10

Max results per page

Required range: 1 <= x <= 100

Response

200

application/json

Per-page feedback aggregates with pagination flag

feedback · object[] · required

List of per-page feedback aggregates.

Show child attributes

hasMore · boolean · required

Whether additional results are available beyond this page.