AI assistant questions
Questions asked of the AI assistant, newest first.
Set maxConfidence to surface the answers the assistant was least sure of. These are the clearest signal of gaps in your documentation. Questions with no confidence score are left out when you use that filter, since there is nothing to compare against the threshold.
curl -X GET "https://api.documentationai.app/api/v1/analytics/ai/questions?startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0&sessionId=example_string&maxConfidence=0.5" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.documentationai.app/api/v1/analytics/ai/questions?startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0&sessionId=example_string&maxConfidence=0.5"
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/ai/questions?startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0&sessionId=example_string&maxConfidence=0.5", {
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/ai/questions?startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0&sessionId=example_string&maxConfidence=0.5", 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/ai/questions?startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0&sessionId=example_string&maxConfidence=0.5')
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",
"questions": [
{
"question": "how to migrate content?",
"answer": "example_string",
"pagePath": "example_string",
"sessionId": "example_string",
"confidenceScore": 0.98,
"askedAt": "2024-12-25T10:00:00Z"
}
],
"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/ai/questions
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 questions to return. Capped lower than other endpoints because full answer text is included.
Number of rows to skip. Combined with total, this is how you page through results.
Return only questions from one session, to reconstruct a conversation. Cannot be combined with maxConfidence.
Return only questions the assistant scored strictly below this value. Cannot be combined with sessionId.
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 questions to return. Capped lower than other endpoints because full answer text is included.
Number of rows to skip. Combined with total, this is how you page through results.
Return only questions from one session, to reconstruct a conversation. Cannot be combined with maxConfidence.
Return only questions the assistant scored strictly below this value. Cannot be combined with sessionId.
0.5