Retrieves detailed productivity metrics for Agents over a specified date range, with optional filters for Campaigns and Agent Emails.
Endpoint:
GET https://api.convoso.com/v1/agent-productivity/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_id | string | ❌ No | Campaign ID to filter by. |
| agent_emails | string | ❌ No | Comma-separated list of agent email addresses to filter by. |
| offset | integer | ❌ No | Number of records to skip for pagination. |
| limit | integer | ❌ No | Maximum number of records to return. Default is 1000 / Max 1000. |
Example Request
GET https://api.convoso.com/v1/agent-productivity/search?auth_token=YOUR_API_TOKEN&date_start=2025-05-01&date_end=2025-05-28&campaign_id=1234&agent_emails=agent@example.com&offset=0&limit=10
Response Format
{
"success": true,
"data": {
"offset": 0,
"limit": "10",
"total": "14",
"entries": [
{
"id": "999999993",
"user_id": "12345678",
"state": "LOGIN",
"availability_code": "1",
"campaign_id": "1234",
"event_epoch": "1748433437",
"event_sec": "00:00:03",
"created_at": "2025-05-28 04:57:17",
"browser": "agent-dt.convoso.com ---- ---- agent-dt.convoso.com ---- Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36",
"ip_address": "124.106.110.20",
"user_uid": "xxxxisbvax4z4mgembpadlrws6xxxx",
"user_name": "Example Agent",
"availability_code_name": "",
"campaign_uid": "xxxxx86t69rrnncou5aj0oqmfi8xxy2",
"campaign_name": "Campaign 1",
"campaign_type": "Normal",
"availability_name": "Login"
}
]
}
}
Response Descriptions
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 productivity result objects (see main table). |
Agent Productivity Object
| Field | Type | Description |
|---|---|---|
| id | string | Record Identifier |
| user_id | string | User Identifier |
| state | string | State of the agent (Login, Ready, NotReady, LogOut) |
| availability_code | string | Availability / Reason Code Identifier |
| campaign_name | string | Name of the associated campaign. |
| event_epoch | string | Unix timestamp of the event |
| events_sec | string | Duration of the event |
| created_at | string | Date / Time the event was created. |
| browser | string | Browser used by the agent |
| ip_address | string | IP Address of the Agent |
| user_uid | string | User Unique Identifier |
| user_name | string | Full Name of the user |
| availability_code_name | string | Availability / Reason Code Description |
| campaign_uid | string | Unique campaign identifier |
| campaign_name | string | Name of the campaign |
| campaign_type | string | Type / Dial Mode of the Campaign (Normal, SMS, Conversational AI, Skill Routing, Toll-Free SMS) |
| availability_name | string | Availability / Reason Code Name |