get https://{domainname}/ca_reports/summaryReport
This API retrieves a summary of agent(s) for your CloudAgent account.
Rate Limit:
A maximum of 5 requests per minute is allowed.
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
Header parameters
| Parameter | Description |
|---|---|
| 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" "message": { " |
| Invalid apiKey | "status": "error" "message": "userName or apiKey is Invalid" |
| Empty apiKey | "status": "error" "message": "apiKey should not be empty" |
| Invalid userName | "status": "error" "message": "userName or apiKey is Invalid" |
| Empty userName | "status": "error" "message": "userName should not be empty" |
| No data is found | "status": "error" "message": "No Data Found" |
| Invalid Date format | "status": "error" "message": "From and To Date should be in yyyy-mm-dd HH:mm:ss Format" |
| If fromDate is more than toDate | "status": "error" "message": "From Date Should not be Greater than To Date" |
| If the requested data is for more than 30 days | "status": "error" "message": "Difference Between From and To Date should not be Greater than 30 Days" |
| When All modeTypes are Invalid | "status": "error" "message": "Mode Type is Invalid" |
| When All agentIds are Invalid | "status": "error" "message": "agentId is Invalid” |