Get the analytics dashboard summary
Returns the main analytics datasets for the selected date range in one response: conversation volume, response-time trends, operator performance, visitor sources, and plan-usage counters.
/api/analytics/realtime-summaryReturns the main analytics datasets for the selected date range in one response: conversation volume, response-time trends, operator performance, visitor sources, and plan-usage counters. This combines the datasets used by the analytics overview. Recently completed writes may take a short time to appear in the result. To use custom dates, send both start and end as ISO 8601 datetimes with offsets. Explicit boundaries override range; a single boundary is rejected. Date buckets are calculated in UTC. Periods with no data return the documented empty or zero-value response. Endpoints that support format=csv return a text/csv download. CSV export may require an eligible plan; JSON is the default.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
analytics: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. Range. Allowed values: 7d, 30d, 90d.
"30d"Value in
- "7d"
- "30d"
- "90d"
Query parameter. ISO 8601 date and time for start.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$date-timeQuery parameter. ISO 8601 date and time for end.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$date-timeQuery parameter. Scope. Allowed values: all.
Value in
- "all"
Query parameter. Format. Allowed values: json, csv.
"json"Value in
- "json"
- "csv"
Header 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
{ "conversationVolume": [ { "date": "2026-06-01", "count": 42 } ], "responseTimes": [ { "avgResponseMs": 192000, "date": "2026-06-01" } ], "operatorPerformance": [ { "operatorId": "33333333-3333-4333-8333-333333333333", "name": "Alex Johnson", "conversationsHandled": 48, "avgResponseMs": 18400 } ], "visitorSources": [ { "source": "Direct", "count": 21 } ], "planUsage": { "plan": "scale", "operators": { "used": 4, "limit": 5 }, "conversations": { "used": 184, "limit": 1000 }, "aiCredits": { "used": 920, "limit": 5000 } }}Request examples
curl
curl --request GET \
'https://api.convor.io/api/analytics/realtime-summary?format=json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/analytics/realtime-summary?format=json", {
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?