Returns current workload and capacity for operators in the authenticated organization.
/api/analytics/team-workloadReturns current workload and capacity for operators in the authenticated organization. scope 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 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.
pages.docs.apiRequirements.bearerApiKey pages.docs.apiRequirements.or pages.docs.apiRequirements.apiKeyHeader.analytics:readautomation_api)Query parameter. Threshold used for this calculation.
Query parameter. Scope. Allowed values: all, active.
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
}
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request GET \
'https://api.convor.io/api/analytics/team-workload' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'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?