Get a Monitor
- Print
- DarkLight
- PDF
Get a Monitor
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/monitors/{username}
Get details of a specific monitor. Permission required: manage-livechat-monitors
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
username
stringRequired
The username of the person monitoring.
Example1-agent
Responses
200
OK
Success Example
{
"_id": "RSb7exHJsiKqwRjPF",
"username": "1-agent",
"emails": [
{
"address": "[email protected]",
"verified": false
}
],
"status": "offline",
"name": "1-agent",
"statusLivechat": "not-available",
"livechat": {
"maxNumberSimultaneousChat": "4"
},
"success": true
}object
_id
string
username
string
emails
Array of object
object
address
string
verified
boolean
status
string
name
string
statusLivechat
string
livechat
object
maxNumberSimultaneousChat
string
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?