/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Analytics Summary

Get Analytics Summary

Aggregated traffic and engagement metrics for a project.

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

Returns aggregated traffic, search and AI assistant totals for the given time window, and a link to download the same window as a report.

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
days:integerquery
Time window in days.
Default30

Response Fields

NameDescription
data.pageViews:object
total page views, uniqueVisitors (distinct visitor IDs; visitors whose browser sends Global Privacy Control or Do Not Track are counted in total but not here, see Global Privacy Control and Do Not Track) and avgDuration (average seconds on page) in the window.
data.search:object
total searches and how many returned zeroResults.
data.chat:object
total AI assistant questions, their avgConfidence (0–1), and thumbs-up/down counts under satisfaction.
data.exportUrl:string
Path to Export Insights for this window, relative to https://api.syntext.dev. Send it with the same Authorization header to download a CSV. days in this URL is clamped to 1–365. Optional — see trend fields.
Note

Exact fields may grow over time — treat unknown fields as forward-compatible additions.

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/summary?days=30" \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": {
"pageViews": {
"total": 48210,
"uniqueVisitors": 12034,
"avgDuration": 94.2
},
"search": {
"total": 3921,
"zeroResults": 212
},
"chat": {
"total": 1287,
"avgConfidence": 0.81,
"satisfaction": { "thumbsUp": 344, "thumbsDown": 41 }
},
"exportUrl": "/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/analytics/export?days=30"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext