The User Activity API provides real-time monitoring data about available agents within the Convoso platform.
Endpoint:
GET https://api.convoso.com/v1/user-activity/search
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | ✅ Yes | API token for authentication |
| campaign_id | string | ❌ No | Filter results to agents assigned to this campaign |
| queue_id | string | ❌ No | Filter results to agent assigned to this queue. |
| user_id | string | ❌ No | Filter results to a specific agent (user) |
| filter_by_skill_options | string | ❌ No | Comma-separated skills to filter agents by (e.g., Spanish,TechSupport). |
Example Request
GET https://api.convoso.com/v1/user-activity/search?auth_token=your_auth_token&campaign_id=123&queue_id=456&user_id=789&filter_by_skill_options=Spanish,TechSupport
Response Format (JSON)
{
"success": true,
"data": {
"available_agents": 36,
"logged_in_agents": 125
}
}
Response Field Definitions
Agents Availability Data
| Field | Type | Description |
|---|---|---|
| available_agents | integer | Number of agents available to be assigned a call |
| logged_in_agents | integer | Number of agents currently logged into the Convoso platform. |