Get Weekly Data When Chat is Busier
- Print
- DarkLight
- PDF
Get Weekly Data When Chat is Busier
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/engagement-dashboard/users/chat-busier/weekly-data
Retrieves weekly data when chat is busier.
Permission required: view-engagement-dashboard
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The token of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The user ID of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
start
stringRequired
The start date.
Example2023-10-29T14:48:00.000Z
Responses
200
OK
Success Example
{
"days": [
{
"day": "2023-02-01",
"users": 1
},
{
"day": "2023-01-24",
"users": 1
},
{
"day": "2023-01-17",
"users": 1
}
],
"period": {
"count": 27,
"variation": 27
},
"yesterday": {
"count": 0,
"variation": 0
},
"success": true
}object
month
Array of object
object
users
integer
day
integer
month
integer
year
integer
success
boolean
400
Bad Request
Missing key
{
"success": false,
"error": "Match error: Missing key 'start'"
}Example 2
{
"success": false,
"error": "Match error: Failed Match.Where validation in field start"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string
Was this article helpful?