Live team workload and capacity
Returns live workload and capacity for operators in the current organization.
/api/analytics/team-workloadReturns live workload and capacity for operators in the current organization. operatorScope defaults to all; set it to active to include only operators whose status is online or away. threshold defaults to 0.8, so the team counts as saturated at 80% of its calculated capacity. threshold is a ratio from 0 to 1. scope selects which operators are counted; neither option changes organization isolation. Omitted values use the parameter defaults.
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. Threshold used for this calculation.
0 <= value <= 10.8Query parameter. Operator scope. Allowed values: all, active.
"all"Value in
- "all"
- "active"
Query parameter. Scope. Allowed values: all.
Value in
- "all"
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
{ "data": { "operators": [ { "operatorId": "44444444-4444-4444-8444-444444444444", "displayName": "Alice Johnson", "status": "online", "activeConversations": 4, "maxConcurrentChats": 5, "utilizationPct": 80, "atCapacity": false, "acceptingNewConversations": true } ], "team": { "operatorCount": 3, "totalActive": 9, "totalCapacity": 12, "saturationPct": 75, "saturated": false, "thresholdPct": 80, "orgMaxConcurrentChats": 20 } }}Request examples
curl
curl --request GET \
'https://api.convor.io/api/analytics/team-workload' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/analytics/team-workload", {
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?