Get Active Users

Prev Next
Get
/api/v1/engagement-dashboard/users/active-users
Premium tag

Retrieve the metrics of active users in the workspace during a specific period.

Permission required: view-engagement-dashboard

Version Description
3.1.0 Added
Header parameters
X-User-Id
stringRequired

The user ID of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired

The token of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
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
400
401
403

OK

Collapse all
object
month
Array of object
object
usersList
Array of string
string
users
integer
day
integer
month
integer
year
integer
success
boolean
Tags