Reports API Version 2 Audit

Introduction

The audit section of the report API allows you to view activities and changes made within the Infinity platform.

Audit Log

Retrieves audit log entries for a particular IGRP.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/audit

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

limit (int) - Limit result set, see Pagination.
offset (int) OPTIONAL - Offset result set, see Pagination.
sort (array) OPTIONAL - One or more sorts, see Sort Types.
filter (array) OPTIONAL - One or more filters, see Filter Types.

Filter Types

Audit logs may be filtered by any of the report fields.

Sort Types

Audit logs may be sorted by any of the report fields.

Response:

Returns a list of audit log entries.

Not all of these fields will be populated for each log entry. If a field is blank or missing then it is not relevant to that log entry.

_id (string) - Identifies the log entry
dt (string) - Datetime of the log entry
app (string) - Application that triggered the log entry
userId (int) - User ID that triggered the log entry
user (string) - Username (login) that triggered the log entry
act (string) - Action taken
notes (string) - Additional notes for the action
orgId (int) - Organisation ID related to the action
orgName (string) - Organisation name related to the action
igrp (int) - IGRP ID related to the action
igrpName (string) - IGRP name related to the action
seg (int) - Segment related to the action

{"_id":"53344546f2370ad4176f1d16","dt":"2014-03-27 15:35:34","app":"portal","user":"user@example.com","act":"igrpLand","userId":123,"orgId":123,"orgName":"Some Org","igrp"123,"igrpName":"Some IGRP"}
{"_id":"5334447df2370ac2176f1d16","dt":"2014-03-27 15:32:13","app":"portal","user":"other.user@example.com","act":"igrpLand","userId":1234,"orgId":1234,"orgName":"Some Other Org","igrp":1234,"igrpName":"Some Other IGRP"}

IGRP User Activity

Retrieves a user activity summary for a particular IGRP.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/audit/userActivity

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

limit (int) - Limit result set, see Pagination.
offset (int) OPTIONAL - Offset result set, see Pagination.
sort (array) OPTIONAL - One or more sorts, see Sort Types.
filter (array) OPTIONAL - One or more filters, see Filter Types.

Filter Types

User activity may be filtered by any of the report fields.

Sort Types

User activity may be sorted by any of the report fields.

Response:

Returns a summary of user activity based on audit log entries. This report shows when users log in to the Infinity portal.

_id (string) - Identifies the log entry
app (string) - Application that triggered the log entry
userId (int) - User ID that triggered the log entry
user (string) - Username (login) that triggered the log entry
orgId (int) - Organisation ID related to the action
orgName (string) - Organisation name related to the action
igrp (int) - IGRP ID related to the action
igrpName (string) - IGRP name related to the action
firstLandDt (string) - First time this user logged in
lastLandDt (string) - Most recent time this user logged in
landCount (int) - Number of times this user has logged in

{"_id":"53344dfef7a3f431900fcbda","app":"portal","firstLandDt":"2014-03-27 16:12:46","igrp":123,"igrpName":"Some IGRP","landCount":1,"lastLandDt":"2014-03-27 16:12:46","orgId":123,"orgName":"Some Org","user":"user@example.com","userId":123}
{"_id":"53344c80f7a3f431900fcbd9","app":"portal","firstLandDt":"2014-03-24 12:43:27","igrp":1234,"igrpName":"Some Other IGRP","landCount":2,"lastLandDt":"2014-03-27 16:06:24","orgId":1234,"orgName":"Some Other Org","user":"other.user@example.com","userId":1234}