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"
import requests
import json
url = "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"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("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", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("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", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('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')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"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
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
{
"error": "Error",
"message": "The analytics store could not be reached. The request was valid — retry after a short delay.",
"code": 502
}
/analytics/feedback
Target server for requests. Edit to use your own host.
API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
Authorization: Bearer dai_...First UTC day to include, as YYYY-MM-DD. Defaults to six days before endDate. The range must not exceed 90 days.
Last UTC day to include, as YYYY-MM-DD. Inclusive — the whole day is counted. Defaults to today.
Maximum number of rows to return
Number of rows to skip. Combined with total, this is how you page through results.
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.
Column to sort by
Sort direction
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
Query Parameters
First UTC day to include, as YYYY-MM-DD. Defaults to six days before endDate. The range must not exceed 90 days.
2026-05-01Last UTC day to include, as YYYY-MM-DD. Inclusive — the whole day is counted. Defaults to today.
2026-05-31Maximum number of rows to return
Number of rows to skip. Combined with total, this is how you page through results.
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.
/guidesResponses
Totals for the whole date range
Pages with feedback in the range