Skip to main content

List activity sessions with a given status

GET 
/api/v1/ActivitySession/SummaryByStatus/:status

Returns a page of activity sessions that have the given status, such as pending, active or waiting for approval. Administrators and auditors can see all users or narrow to one user or group, and everyone else sees only their own sessions.

Permission required: Any signed-in user. Administrators see all sessions, auditors see the sessions they are allowed to audit, and other users see only their own. The user, group and keystroke filters apply only to administrators and auditors.

Values for status: -1 = ApprovalRequired, 0 = Pending, 1 = Active, 2 = Cancelling, 3 = Complete, 4 = Failed, 5 = Cancelled, 6 = ApprovalDenied, 7 = ApprovalFailed.

Values for streamType: -1 = Unknown, 0 = All, 1 = Windows_Audit, 2 = StdIn, 3 = StdOut.

Request​

Responses​

Returns the matching session summaries in data and the total number of matches in recordsTotal. With take set to 0 and no group filter, data is empty and recordsTotal still shows the match count. When metadataFilterText is used, recordsTotal is the number of sessions on the returned page rather than the full match count.