Retrieves performance metrics for one or more Agents over a specified date range, filtered by Campaign, List, Queue, User, and Status.
Endpoint:
GET https://api.convoso.com/v1/agent-performance/search
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | ✅ Yes | Your API authentication token. |
| date_start | string | ❌ No | Start date for the report in YYYY-MM-DD format. |
| date_end | string | ❌ No | End date for the report in YYYY-MM-DD format. |
| campaign_ids | string | ❌ No | Comma-separated list of campaign IDs to filter by. |
| list_ids | string | ❌ No | Comma-separated list of list IDs to filter by. |
| queue_ids | string | ❌ No | Comma-separated list of queue IDs to filter by. |
| user_ids | string | ❌ No | Comma-separated list of user IDs to filter by. |
| status_ids | string | ❌ No | Comma-separated list of status IDs to filter by. |
Example Request
GET https://api.convoso.com/v1/agent-performance/search?auth_token=YOUR_API_TOKEN&date_start=2025-05-01&date_end=2025-05-28&user_ids=123456
Response Format
Example Response
{
"success": true,
"code": 200,
"total": 1,
"data": {
"1234567": {
"name": "Example Agent",
"calls": 843,
"human_answered": 708,
"talk_sec_pt": 39.43,
"wait_sec_pt": 49.18,
"pause_sec_pt": 9.1,
"wrap_sec_pt": 2.28,
"talk_sec": "03:24:51",
"wait_sec": "04:15:30",
"pause_sec": "00:47:17",
"wrap_sec": "00:11:51",
"total_time": "08:39:29",
"am": 135,
"others": 708,
"am_pt": 16.01,
"others_pt": 83.99,
"call_type": "",
"user_id": "1234567"
}
}
}
Response Definitions
Top-Level Request Metadata
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| code | integer | Result code |
| total | string | Total number of matching agent performance records. |
| data | array | Array of agent performance result objects (see main table). |
Agent Performance Object
| Field | Type | Description |
|---|---|---|
| user_id | string | Unique identifier for the agent. |
| name | string | Full name of the agent. |
| calls | integer | Number of calls owned by each Agent. |
| human_answered | integer | Number of calls picked up by Lead or answered by Agent. |
| talk_sec_pt | float | Percentage of time spent on a call. |
| wait_sec_pt | float | Percentage of time Agent spent waiting for a call in a Ready Status. |
| pause_sec_pt | float | Percentage of time Agent spent in a Not Ready Status. |
| wrap_sec_pt | float | Percentage of time Agent spent in Wrap-Up. |
| talk_sec | string | Total time an agent spent on a call expressed in HH:MM:SS (hours, minutes, seconds). |
| wait_sec | string | Total Time an agent spent waiting in a Ready Status expressed in HH:MM:SS (hours, minutes, seconds.) |
| pause_sec | string | Total Time Agent spent in a Not Ready Status expressed in HH:MM:SS (hours, minutes, and seconds). |
| wrap_sec | string | Total time Agent spent in Wrap-Up expressed in HH:MM:SS (hours, minutes, and seconds). |
| total_time | string | Total time Agent spent logged in expressed in HH:MM:SS (hours, minutes, and seconds). |
| am | integer | Total number of Agent's calls that were Dispositioned as a Voicemail/Answering Machine. |
| others | integer | Total number of Agent's calls that were not Dispositioned as a Voicemail/Answering Machine. |
| am_pt | float | Percentage |
| others_pt | float | Total number of Agent's calls that were not Dispositioned as a Voicemail/Answering Machine. |
| call_type | string | Call Types the agent is engaged in. |