/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get AI Insights

Get AI Insights

AI assistant analytics: query volume, confidence, satisfaction, topics, sources, trends, and unresolved intents.

GET/v1/projects/{projectId}/analytics/aiTry it
Session token

Returns analytics for the project's AI assistant — query volume, answer confidence, visitor satisfaction, per-topic confidence, how often answers cite your docs, a daily series, changes against the previous window, and the questions the AI couldn't answer well.

Note

Session JWT and org membership required. Any role can read it — an API key gets 401, a non-member 403. Any plan.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Query Parameters

NameDescription
period:stringquery
Time window: 24h, 7d, or 30d. Takes precedence over days.
days:integerquery
Time window in days (used when period is not provided).
Default30

Response Fields

NameDescription
data.avgConfidence:number
0–1 score: how well the docs grounded each answer.
data.satisfactionRate:number
Thumbs-up share of all rated answers, 0–1.
data.topTopics:array
Up to 10 topics, most asked first. A topic is the page the question was asked on (General when there was none). rising: true marks a topic with 5 or more questions in this window that grew by at least half against the previous window, or had none before; the field is absent otherwise.
data.unresolvedIntents:array
Up to 10 open documentation gaps, most frequent first. The full list is at List Gaps.
data.daily:array
Questions per UTC day in the window, { date, count }, oldest first. Days with no questions are left out.
data.answeredWithSources:number | null
Share of questions whose answer cited at least one source, 0–100. null when there were no questions.
data.confidence:object | null
Shares of answers by cited sources, 0–100: high (3 or more), medium (1–2), low (none). null when there were no questions. These buckets count cited sources, unlike avgConfidence, the assistant's own confidence in its answers.
data.changes:object
questions (percent) and answeredWithSources (points) against the previous window of the same length. A key is left out when there is nothing to compare with.

topTopics[].rising, daily, answeredWithSources, confidence and changes are optional — see trend fields. If the analytics query itself fails, the response is 200 with every figure 0 and empty lists.

Error Responses

401 Unauthorized

Missing, invalid or expired session JWT, or an API key.

403 Forbidden

You are not a member of the organization that owns the project.

404 Not Found

The project does not exist or has been deleted.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl "https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/analytics/ai?period=7d" \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": {
"totalQueries": 412,
"avgConfidence": 0.83,
"lowConfidenceCount": 17,
"satisfactionRate": 0.91,
"avgAnswerLength": 264,
"topTopics": [
{ "topic": "/guides/authentication", "count": 96, "avgConfidence": 0.94, "rising": true },
{ "topic": "/api-reference/webhooks", "count": 41, "avgConfidence": 0.61 }
],
"unresolvedIntents": [
{ "intent": "how do i rotate my api keys", "count": 8 }
],
"daily": [
{ "date": "2026-11-02", "count": 51 },
{ "date": "2026-11-03", "count": 64 }
],
"answeredWithSources": 87.4,
"confidence": { "high": 52.2, "medium": 35.2, "low": 12.6 },
"changes": { "questions": 18, "answeredWithSources": 3.1 }
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext