get /audit/events
Get audit data.
Get audit data.
The data can be filtered by a particular date, app, user, target and data type.
Stability index
This API is under development. Do not rely on it. It may change or be removed in future versions.
Query parameters
- offset (optional)
- The number of entries to skip. Default is 0.
- limit (optional)
- The maximum number of entries to return. Default is 50.
- start (optional)
The start date to filter on in UTC timezone and format yyyy-MM-ddTHH:mm:ssZ.
Example: 2020-09-15T11:59:08Z
- end (optional)
The end date to filter on in UTC timezone and format yyyy-MM-ddTHH:mm:ssZ.
Example: 2020-09-15T11:59:08Z
- appId (optional)
- The ID of the app to filter on.
- userId (optional)
- The ID of the user to filter on.
- targetId (optional)
- The ID of the target to filter on.
- target (optional)
- The target name to filter on.
- dataType (optional)
- The data type to filter on.
Return type
Example data
Content-Type: application/json
{
"data" : {
"totalItems" : 0,
"offset" : 6,
"limit" : 1,
"items" : [ {
"targetName" : "targetName",
"targetId" : "00000000-0000-0000-0000-000000000000",
"data" : "{}",
"dataType" : "dataType",
"ipAddress" : "ipAddress",
"description" : "description",
"source" : "source",
"userName" : "userName",
"userId" : "00000000-0000-0000-0000-000000000000",
"target" : "target",
"appId" : "00000000-0000-0000-0000-000000000000",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"action" : "action",
"id" : "00000000-0000-0000-0000-000000000000"
}, {
"targetName" : "targetName",
"targetId" : "00000000-0000-0000-0000-000000000000",
"data" : "{}",
"dataType" : "dataType",
"ipAddress" : "ipAddress",
"description" : "description",
"source" : "source",
"userName" : "userName",
"userId" : "00000000-0000-0000-0000-000000000000",
"target" : "target",
"appId" : "00000000-0000-0000-0000-000000000000",
"eventTime" : "2000-01-23T04:56:07.000+00:00",
"action" : "action",
"id" : "00000000-0000-0000-0000-000000000000"
} ]
}
}
Responses
- 200
- Success. The paginated audit data are returned.
- 400
- Parameters of the query string are malformed.