Get the operator leaderboard
Returns a ranked leaderboard of operators in the current organization.
/api/operators/leaderboardReturns a ranked leaderboard of operators in the current organization. period sets the reporting window, sortBy chooses the ranking metric, and limit caps the number of rows. Defaults are period=30d, sortBy=handled, and limit=25. Set period=all to include all historical conversations instead of a rolling window.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
operators: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. Period. Allowed values: 7d, 30d, 90d, all.
"30d"Value in
- "7d"
- "30d"
- "90d"
- "all"
Query parameter. Sort by. Allowed values: handled, resolutionRate, avgResponseTime, csatScore, activeConversations.
"handled"Value in
- "handled"
- "resolutionRate"
- "avgResponseTime"
- "csatScore"
- "activeConversations"
Query parameter. Maximum number of records to return.
1 <= value <= 10025Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "period": "30d", "sortBy": "handled", "data": [ { "rank": 1, "operatorId": "550e8400-e29b-41d4-a716-446655440000", "userId": "550e8400-e29b-41d4-a716-446655440001", "displayName": "Alex Johnson", "userEmail": "[email protected]", "userName": "Alex Johnson", "userImage": null, "handled": 48, "conversationsHandled": 48, "closed": 36, "resolutionRate": 0.75, "avgResponseTime": "2m 14s", "avgResponseSeconds": 134, "csatScore": 4.6, "activeConversations": 5 } ]}Request examples
curl
curl --request GET \
'https://api.convor.io/api/operators/leaderboard' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/operators/leaderboard", {
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?