Get plan usage including conversations, operators, and AI credits
Returns plan-usage counters for the current organization, including operator seats, conversation usage, and AI credits compared with the active plan limits.
/api/analytics/plan-usageReturns plan-usage counters for the current organization, including operator seats, conversation usage, and AI credits compared with the active plan limits. Usage and limits belong to the authenticated organization. New usage fields may be added without a version change.
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.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "plan": "scale", "operators": { "used": 4, "limit": 5 }, "conversations": { "used": 382, "limit": 5000 }, "aiCredits": { "used": 1200, "limit": 5000 }}Request examples
curl
curl --request GET \
'https://api.convor.io/api/analytics/plan-usage' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/analytics/plan-usage", {
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?
Get operator performance metrics
Lists operator performance for the selected date range, including conversations handled and average first-response time.
Get realtime queue depth and average wait time for unassigned conversations
Returns a live queue snapshot for open or pending conversations that are still unassigned.