Returns real-time workload and capacity data for operators in the current organization. `scope` defaults to `all`; use `active` to limit the result to operators whose status is `online` or `away`. `threshold` defaults to `0.8`, which means the team is marked as saturated at 80% of its calculated capacity. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. The optional `threshold` is a ratio from 0 to 1 and `scope` selects the workload population without changing organization isolation. Omitted values use the route defaults shown in the parameter schemas. Retry behavior: This read-only operation is safe to retry.
/api/analytics/team-workloadOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
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?
Poll the status of an async analytics PDF export (#844)
Polls one asynchronous analytics PDF export. A running job returns `202`; a completed job returns the PDF attachment with `200`; an unknown job returns `404`; a failed job returns `500` with its queue error. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Running states are `waiting`, `active`, or `delayed`. Poll with backoff and stop after `200`, `404`, or `500`. Job identifiers are opaque queue IDs and must not be parsed. Retry behavior: This read-only operation is safe to retry.
Conversations
The conversations view is the central hub for your support team. It shows all active, pending, and resolved conversations in a unified inbox.