Get Status of Agents
- Print
- DarkLight
- PDF
Get Status of Agents
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/analytics/dashboards/charts/agents-status
Retrieves the number of agents for each status. Permission required: view-livechat-manager
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
departmentId
string
The department ID.
Responses
200
OK
Example 1
{
"_id": null,
"offline": 78,
"away": 5,
"busy": 0,
"available": 3,
"success": true
}object
_id
string
offline
integer
away
integer
busy
integer
available
integer
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?