4.1.3. Sessions (Post) Endpoint

Sessions

Gets a list of sessions with details (including productivity time, idle time, and duration).

POST

start

Sessions that were started or finished after this time will be added to the selection.

string

Examples:

"2021-04-01"

"2021-04-01T12:00"

"2021-04-01T12:00:00"

No

end

Sessions that were started or finished before this time will be added to the selection.

string

Examples:

"2021-04-01"

"2021-04-01T12:00"

"2021-04-01T12:00:00"

No

sessionCount

The number of sessions to be returned within 1 request.

Default value: 1000

Max value: 1000

int32

Any integer from 0 to 1000.

No

pageIndex

The page number to be returned starting from the page number with this page index within the session.

int32

Any integer from 0 upwards.

No

Example Response

sessions:

The list of sessions (with detailed info for each session):

{
  "sessions" : [ {

    "duration": "20:20:40.0020000",
    "idleTime": "12:57:42.3480000",
    "productivityTime": "07:22:57.6540000",
    "clientGuid": "5d4fe546-8aff-4510-a814-f6a8ee14effq",
    "clientName": "clientname1",
    "logoutDate": "2000-01-23T04:56:07.000+00:00",
    "loginDate" : "2000-01-23T04:56:07.000+00:00",
    "sessionId" : 613,
    "userName" : "username1",
    "userId" : 19
  }, {
    "duration" :
    "8:12:25.7950000",
    "idleTime" : "11:55:42.3480000",
    "productivityTime" : "11:22:66.6540000",
    "clientGuid" : "qi4fe546-8aff-4513-a814-f6a8ee14effq",
    "clientName" : "clientname2",
    "logoutDate" : "2000-01-23T04:56:07.000+00:00",
    "loginDate" : "2000-01-23T04:56:07.000+00:00",
    "sessionId" : 16,
    "userName" : "username2",
    "userId" : 7
  } ],
 "totalCount" : 4
}

• duration (timespan)

• The duration of the session.

• idleTime (timespan)

• The total time when the user was not active.

• productivityTime (timespan)

• The total time when the user was active.

• clientGuid (string)

• The GUID of the Client.

• logoutDate (date-time)

• The date & time when the session ended.

• loginDate (date-time)

• The date & time when the session started.

• sessionId (int32)

• The ID of the session.

• userName (string)

• The user name.

• userId (int32)

• The ID of the user.

• The number of sessions.