Retrieve a filtered list of audit trail events

POST 
/v1/audit-trail

Retrieve a filtered list of audit trail events

Request

application/json

Body

size int32

Possible values: <= 500

Default value: 500

Maximum number of results to return.

from int32

Possible values: <= 2147483647

Of the results found, the first result to return.

auditEventUser object

id int32

ID of the user or token

fullName string

First and last name of the user, or name of the token

deleted boolean

If this user or token has been deleted, true. Otherwise, false.

userToken boolean

If this is a token, true. If this is a user, false.

auditEventType string

Code for the event type

fromDate int64

Starting timedate, as Unix epoch milliseconds.

toDate int64

Ending timedate, as Unix epoch milliseconds.

sortDescending boolean

To sort results in descending order, true. For ascending order, false.

includeFiltersData boolean

Responses

200

successful operation

application/json

Schema

Schema

pageSize int32

Possible values: <= 500

The number of results requested

from int32

Possible values: <= 2147483647

Of the results found, the first result returned.

total int64

Possible values: <= 500

Total number of results that met the search criteria.

results object[]
Array [
auditEventUser object
id int32
ID of the user or token
fullName string
First and last name of the user, or name of the token
deleted boolean
If this user or token has been deleted, true. Otherwise, false.
userToken boolean
If this is a token, true. If this is a user, false.
date int64
Date of the audit event, as Unix epoch milliseconds
auditEventTypeTitle string
The event type
ip string
IP address of the client device that generated the event
geoLocation string
Geographical location of the device that made the request
extraDataList object[]
Array [
fieldName string
Name of the field
oldValue string
Original value of the field
newValue string
New value of the field
]
valid boolean
]
auditEventUsersList object[]
Array [
id int32
ID of the user or token
fullName string
First and last name of the user, or name of the token
deleted boolean
If this user or token has been deleted, true. Otherwise, false.
userToken boolean
If this is a token, true. If this is a user, false.
]
auditEventTypesList object[]
Array [
auditEventType string
Code for the event type
auditEventTypeTitle string
Description of the event type
]

Example (from schema)

{
  "pageSize": 50,
  "from": 0,
  "total": 0,
  "results": [
    {
      "auditEventUser": {
        "id": 5374,
        "fullName": "Larry Appleton",
        "deleted": false,
        "userToken": true
      },
      "date": 1527168668,
      "auditEventTypeTitle": "Admin created a sub account",
      "ip": "52.203.237.249",
      "geoLocation": "New York - USA",
      "extraDataList": [
        {
          "fieldName": "Account name",
          "oldValue": "Test account",
          "newValue": "Apache access logs"
        }
      ],
      "valid": true
    }
  ],
  "auditEventUsersList": [
    {
      "id": 5374,
      "fullName": "Larry Appleton",
      "deleted": false,
      "userToken": true
    }
  ],
  "auditEventTypesList": [
    {
      "auditEventType": "Added user",
      "auditEventTypeTitle": "Added user"
    }
  ]
}

Loading...