This API retrieves a summary of agent(s) for your CloudAgent account.
Rate Limit:
A maximum of 5 requests per minute is allowed.
Note:
- This API supports both POST and GET methods. Please use the appropriate method based on your use case for optimal functionality.
- Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.
Header parameters
| Parameter | Description |
|---|---|
| apiKey* | Your CloudAgent account API Key |
| Content-Type | application/json |
Body Params
{
"fromDate": "2024-11-28 13:00:00",
"toDate": "2024-11-28 13:59:59",
"userName": "xxxxx",
"agentId":"Agent1,Agent2",
"modeType":"inbound,progressive"
}
Possible responses
Success response | "status": "success" |
Invalid apiKey | "status": "error" |
Empty apiKey | "status": "error" |
Invalid userName | "status": "error" |
Empty userName | "status": "error" |
No data is found | "status": "error" |
Invalid Date format | "status": "error" |
If fromDate is more than toDate | "status": "error" |
If the requested data is for more than 30 days | "status": "error" |
When All modeTypes are Invalid | "status": "error" |
When All agentIds are Invalid | "status": "error" |