API Reference

Get aggregated session activity

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

Returns aggregated session activity metrics (avg/min/max/count) grouped by a single session dimension such as folder, delivery group, site, user, protocol, or initial program. Visit the Session Activity Report documentation for column descriptions and more details.

Query Params
string
enum
required

Single session dimension to group rows by.

metrics
array of strings
required

One or more session metrics to aggregate. Repeat the parameter for multiple values.

metrics*
aggregations
array of strings

Aggregation functions to apply to each metric. Repeat for multiple. Default: avg.

aggregations
Allowed:
string

Response field to sort by (must equal a returned

string
enum

Sort order. Default: desc.

Allowed:
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

string

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

string

Filter sessions by server name.

int32

Minimum logon duration in seconds (pre-aggregation filter).

int32

Maximum logon duration in seconds (pre-aggregation filter).

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 3 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 3 months ago

Did this page help you?