Get user activity status

get

https://api.controlup.com/historical/v1/users/activity

Returns a list of users and their activity status throughout the search period. The search period is divided into smaller time windows according to the granularity parameter. The endpoint returns a user's activity status for each time window.

Required permission: Session Activity

❗️
The built-in Try It! console can return incorrect values. This endpoint returns IDs that are automatically rounded and displayed incorrectly in the response body due to a Javascript limitation.

Use the console to build requests and test connectivity only.

To get accurate data, copy the request and run it in another tool.

Query Params

userAccount

string

Only return activity data for the specified user account (user_account).

granularity

string

enum

required

Sets the length of the time windows in which a user activity statuses are returned. For example, if you set this to 5m then you can see a user's activity status for each 5 minute interval throughout the search period.

Allowed:

_timeFrom

date-time

required

Start date and time of the search period in the format: YYYY-MM-DD'T'hh:mm:ss.sssZ

_timeTo

date-time

required

End date and time of the search period in the format: YYYY-MM-DD'T'hh:mm:ss.sssZ

_page

int32

≥ 1

The page number returned. The first page is 1.

_limit

int32

1 to 100000

The number of items returned per page. Minimum is 1.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successfully retrieved

400Bad Request - one of the inputs isn't correct

401User is not authorized to access the resource

403Authorization details are not provided

500Internal Server Error

501Internal Server Error

504Internal Server Error