AnalyticsWritten feedback for a page

Written feedback for a page

Individual feedback entries for one page, newest first. Only entries that included written text are returned, so a page with ratings but no comments returns an empty list and a total of zero.

curl -X GET "https://api.documentationai.app/api/v1/analytics/feedback/comments?pagePath=%2Fgetting-started%2Fintroduction&startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "startDate": "example_string",
  "endDate": "example_string",
  "pagePath": "example_string",
  "comments": [
    {
      "id": "example_string",
      "type": "like",
      "text": "example_string",
      "sessionId": "example_string",
      "submittedAt": "2024-12-25T10:00:00Z"
    }
  ],
  "total": 42
}
GET
/analytics/feedback/comments
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
pagePathstring
Required

Exact page path to read comments for

Min length: 1
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
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

pagePathstring
Required

Exact page path to read comments for

Example:
/getting-started/introduction
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.

Responses

startDatestring
endDatestring
pagePathstring
commentsarray
totalinteger