Get Number of Chats
- Print
- DarkLight
- PDF
Get Number of Chats
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/analytics/departments/amount-of-chats
Gives the number of chat rooms by department. 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
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
count
integer
The number of items to return.
Example25
start
stringRequired
The start date.
Example2020-09-10T23:59:22.345Z
end
stringRequired
The end date.
Example2020-09-09T00:11:22.345Z
answered
boolean
Whether the chats are answered or not.
departmentId
string
Enter the department ID for which you want the number of chats.
Example64181a0728384134ed600dcc
Responses
200
OK
Success Example
{
"departments": [
{
"rooms": 13,
"_id": "NJaMpSvZFZ4NAXm3j"
},
{
"rooms": 10,
"_id": "8MGLTfaKLCbE9CqR8"
},
{
"rooms": 4,
"_id": "MpAiP9PMyHwBcmALx"
},
{
"rooms": 51,
"_id": "Yi87Ju7eTHiZQ7CJt"
}
],
"count": 4,
"offset": 0,
"total": 11,
"success": true
}object
departments
Array of object
object
rooms
integer
_id
string
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'start' [invalid-params]",
"errorType": "invalid-params"
}Example 2
{
"success": false,
"error": "The \"start\" query parameter must be a valid date."
}Example 3
{
"success": false,
"error": "must have required property 'end' [invalid-params]",
"errorType": "invalid-params"
}Example 4
{
"success": false,
"error": "The \"end\" query parameter must be a valid date."
}object
success
boolean
error
string
errorType
string
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?