Get feedback by page

GET

/

v1

/

analytics

/

/

feedback

/

by-page

Get feedback by page

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

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

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

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

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.

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

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"

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,

agent,

thumbs_only

status

string

Comma-separated list of statuses to filter by

Per-page feedback aggregates with pagination flag

feedback

object[]

required

Feedback counts aggregated by documentation page path.

hasMore

boolean

required

Whether additional results are available beyond this page.

⌘I