AnalyticsFeedback by page

Feedback by page

Rating totals with one row per page, so you can find the pages readers are least happy with.

The summary block covers the whole date range, not just the rows returned. To read the actual written comments for a page, use /analytics/feedback/comments.

curl -X GET "https://api.documentationai.app/api/v1/analytics/feedback?startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0&pathContains=%2Fguides&sortBy=totalFeedback&sortOrder=desc" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "startDate": "example_string",
  "endDate": "example_string",
  "pages": [
    {
      "pagePath": "example_string",
      "pageTitle": "example_string",
      "likes": 42,
      "dislikes": 42,
      "totalFeedback": 42,
      "comments": 42,
      "satisfactionRate": 3.14
    }
  ],
  "summary": {
    "totalFeedback": 42,
    "likes": 42,
    "dislikes": 42,
    "comments": 42,
    "satisfactionRate": 3.14
  },
  "total": 42
}
GET
/analytics/feedback
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
query
startDatestring

First UTC day to include, as YYYY-MM-DD. Defaults to six days before endDate. The range must not exceed 90 days.

Pattern: ^\d{4}-\d{2}-\d{2}$
query
endDatestring

Last UTC day to include, as YYYY-MM-DD. Inclusive — the whole day is counted. Defaults to today.

Pattern: ^\d{4}-\d{2}-\d{2}$
query
limitinteger

Maximum number of rows to return

Min: 1 • Max: 100
query
offsetinteger

Number of rows to skip. Combined with total, this is how you page through results.

Min: 0
query
pathContainsstring

Return only pages whose path contains this text. Case-insensitive substring match against the page path only — it does not search titles or comment text.

Min length: 1
query
sortBystring

Column to sort by

Options: totalFeedback, likes, dislikes, comments, satisfactionRate
query
sortOrderstring

Sort direction

Options: asc, desc
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

Query Parameters

startDatestring

First UTC day to include, as YYYY-MM-DD. Defaults to six days before endDate. The range must not exceed 90 days.

Example:
2026-05-01
endDatestring

Last UTC day to include, as YYYY-MM-DD. Inclusive — the whole day is counted. Defaults to today.

Example:
2026-05-31
limitinteger

Maximum number of rows to return

offsetinteger

Number of rows to skip. Combined with total, this is how you page through results.

pathContainsstring

Return only pages whose path contains this text. Case-insensitive substring match against the page path only — it does not search titles or comment text.

Example:
/guides
sortBystring

Column to sort by

Allowed values:totalFeedbacklikesdislikescommentssatisfactionRate
sortOrderstring

Sort direction

Allowed values:ascdesc

Responses

startDatestring
endDatestring
pagesarray
summaryobject

Totals for the whole date range

totalinteger

Pages with feedback in the range