Get Hourly Data When Chat is Busier

Prev Next
Get
/api/v1/engagement-dashboard/users/chat-busier/hourly-data
Premium tag

Retrieve hourly 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
{
  "hours": [
    {
      "users": 3,
      "hour": 22
    },
    {
      "users": 3,
      "hour": 20
    },
    {
      "users": 4,
      "hour": 18
    },
    {
      "users": 2,
      "hour": 16
    },
    {
      "users": 4,
      "hour": 14
    },
    {
      "users": 4,
      "hour": 12
    },
    {
      "users": 2,
      "hour": 10
    },
    {
      "users": 1,
      "hour": 8
    },
    {
      "users": 1,
      "hour": 6
    },
    {
      "users": 1,
      "hour": 4
    },
    {
      "users": 0,
      "hour": 2
    },
    {
      "users": 0,
      "hour": 0
    }
  ],
  "success": true
}
Expand All
object
hours
Array of object
object
users
integer
hour
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
Tags