Skip to content
Convor
Convor Docs
API ReferenceAnalytics

Get operator performance for dashboard

Returns a dashboard-ready list of operator performance metrics for the selected time window.

GET/api/analytics/operators

Returns a dashboard-ready list of operator performance metrics for the selected time window. When range is omitted, the route uses the last 30d. To use custom dates, send both start and end as ISO 8601 datetimes with offsets. Explicit boundaries override range; a single boundary is rejected. Date buckets are calculated in UTC. Periods with no data return the documented empty or zero-value response. Endpoints that support format=csv return a text/csv download. CSV export may require an eligible plan; JSON is the default.

Endpoint requirements

Credentials
Use either Bearer API key or X-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

range?string

Query parameter. Range. Allowed values: 7d, 30d, 90d.

Default"30d"

Value in

  • "7d"
  • "30d"
  • "90d"
start?string

Query parameter. ISO 8601 date and time for start.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
end?string

Query parameter. ISO 8601 date and time for end.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
scope?"all"

Query parameter. Scope. Allowed values: all.

Value in

  • "all"
sortBy?string

Query parameter. Sort by. Allowed values: name, handled, responseTime, resolutionTime, csat, resolutionRate, messages, activeConversations.

Default"handled"

Value in

  • "name"
  • "handled"
  • "responseTime"
  • "resolutionTime"
  • "csat"
  • "resolutionRate"
  • "messages"
  • "activeConversations"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Default"desc"

Value in

  • "asc"
  • "desc"
search?string

Query parameter. Search text.

Lengthlength <= 200
page?integer

Query parameter. One-based page number.

Range1 <= value <= 9007199254740991
limit?integer

Query parameter. Maximum number of records to return.

Range1 <= value <= 100

Header Parameters

X-Project-Id?|

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": [    {      "operatorId": "11111111-1111-4111-8111-111111111111",      "name": "Alex Johnson",      "responseTime": "18.4s",      "avgResponseMs": 1,      "csat": 92,      "handled": 48,      "resolutionRate": 75,      "avgResolutionTime": 1640,      "csatAverage": 4.6,      "messagesSent": 126,      "activeConversations": 5    }  ]}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/analytics/operators' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/analytics/operators", {
  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 offline/after-hours message funnel and conversion rate

Measures conversations created outside business hours, defined here as 09:00 through 16:59 server time.

Get operator performance metrics

Lists operator performance for the selected date range, including conversations handled and average first-response time.

On this page

Request examplescurlJavaScript