Get User By Time of the Day

Get
/api/v1/engagement-dashboard/users/users-by-time-of-the-day-in-a-week
Premium tag

Retrieve users by hours at a particular time of the day in a week.

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
end
stringRequired

The end date.

Example2023-11-05T14:48:00.000Z
Responses
200

OK

Success Example
{
  "week": [
    {
      "users": 1,
      "hour": 23,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 22,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 21,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 20,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 19,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 18,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 17,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 16,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 15,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 14,
      "day": 2,
      "month": 5,
      "year": 2023
    },
    {
      "users": 1,
      "hour": 1,
      "day": 1,
      "month": 5,
      "year": 2023
    }
  ],
  "success": true
}
Expand All
object
week
Array of object
object
users
integer
hour
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
Tags