Get Status of Agents

Retrieves the number of agents for each status.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/analytics/dashboards/charts/agents-status
​yes​
Permission required: view-livechat-manager
Query Parameters
Key
Example Value
Description
departmentId
CAJioQNAvLnYWTy8i
The department ID. This parameter is optional.
Example Call
curl --location --request GET 'http://localhost:3000/api/v1/api/v1/livechat/analytics/dashboards/charts/agents-status\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
Example Response
{
    "_id": null,
    "offline": 78,
    "away": 5,
    "busy": 0,
    "available": 3,
    "success": true
}

HTTP Method	URL	Requires Auth
`GET`	`/api/v1/livechat/analytics/dashboards/charts/agents-status`	yes

Key	Example Value	Description
`departmentId`	`CAJioQNAvLnYWTy8i`	The department ID. This parameter is optional.

Last modified 4d ago