Get CSAT analytics
Returns CSAT summary metrics for the current organization over the selected period.
/api/csat/analyticsReturns CSAT summary metrics for the current organization over the selected period. The response includes average score, total responses, response rate, score distribution, per-operator averages, and a daily trend. The period query defaults to 30d and accepts 7d, 30d, or 90d.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
csat:read- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
Query Parameters
Query parameter. Unique identifier of the related project.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidQuery parameter. Scope. Allowed values: all.
Value in
- "all"
Query parameter. Period. Allowed values: 7d, 30d, 90d.
"30d"Value in
- "7d"
- "30d"
- "90d"
Query parameter. Operator sort by. Allowed values: name, averageScore, totalResponses.
"totalResponses"Value in
- "name"
- "averageScore"
- "totalResponses"
Query parameter. Operator sort direction. Allowed values: asc, desc.
"desc"Value in
- "asc"
- "desc"
Query parameter. Value of operatorSearch.
length <= 160Query parameter. Value of operatorPage.
1 <= value <= 9007199254740991Query parameter. Value of operatorLimit.
1 <= value <= 100Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "scope": "single", "scoreScale": "raw", "averageScore": 4.25, "totalResponses": 12, "responseRate": 60, "scoreDistribution": { "1": 0, "2": 1, "3": 2, "4": 4, "5": 5 }, "operatorPerformance": [ { "operatorId": "66666666-6666-4666-8666-666666666666", "averageScore": 4.5, "totalResponses": 4 } ], "trend": [ { "date": "2026-06-23", "averageScore": 4.25, "totalResponses": 12 } ], "projectBreakdown": [ { "projectId": "11111111-1111-4111-8111-111111111111", "projectName": "Example name", "ratingScale": "stars5", "averageScore": 1, "totalResponses": 1, "responseRate": 1 } ]}Request examples
curl
curl --request GET \
'https://api.convor.io/api/csat/analytics' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/csat/analytics", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?