API Reference

Get session statistics

get
https://api.controlup.com/historical/v1/sessions

Returns statistics for all user sessions. Visit the Session Activity Report documentation for column descriptions and more details.

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
string
enum
required

Set the type of statistics to return for each user session.

Allowed:
string

Filter sessions by user account, provided in the Domain\username format.

string

Filter sessions by user display name (partial match, e.g. 'John Doe'). If both userName and userAccount are provided, userAccount takes precedence.

string

Filter sessions by server name. This parameter is only applicable when the preset is set to LIST.

date-time
required

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

date-time
required

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

int32

Minimum logon duration in seconds

int32

Maximum logon duration in seconds

int32
≥ 1

The page number returned. The first page is 1.

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

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?