Use this resource to request entries from the audit log.
GET Request
To request the most recent 200 entries in the audit log, use the following URI.
/api/v2/auditlog
To request a specific batch of audit log entries, define the batch size and request a batch number with the following URI.
/api/v2/auditlog?batchId=<batchId>&batchSize=<batchSize>
Include the following information in the GET URI
Field | Required | Description |
---|---|---|
batchSize | Yes | Number of entries to include in a batch. |
batchId | Yes | The batch that you want to view. |
GET Response
Returns an auditLogEntry object for each audit log entry returned. Returns the error object if errors occur.
The auditLogEntry object includes the following attributes:
Field | Type | Description |
---|---|---|
id | String | Audit log entry ID. |
version | int | Version |
orgId | String | Organization ID. |
username | String | User who performed the action. |
entryTime | Time the action occurred. | |
objectId | String | ID of the object used. |
objectName | String | Name of the object used. |
category | String | Category of audit log entry. Returns one of the following codes: |
event | Type of action performed. Returns one of the following codes: | |
eventParam | Objects related to the action. | |
message | Additional information. |
GET Example
To view rows 21-40, you might use the following URI.
/api/v2/auditlog?batchId=1&batchSize=20