Agent State Summary (Token Authentication)

This API provides a summary report of agent states for given filters.

❗️

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.

To use this API with the help of a token, follow these steps:

  1. Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
  2. Enter the Token ID: Navigate to the right section of this page, under the 'CREDENTIALS' tab. Here, input the generated token ID.
  3. With the token entered, pass the header and body parameters:

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”

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!