GET /data/v1/audit/auditEvents
Retrieves logged Audit Trail audit events for the current account and its children. Logins are audited at the enterprise level.
Audit Trail stores data in the U.S. Central Standard Time (GMT-6, CST) timezone. Audit data pulled using the REST API has a CST timestamp.
Name | Type | Description | |
---|---|---|---|
$page | number | Page number to return from the paged results. Start with 1 and continue until you get zero results. Typically provided along with the $pagesize parameter. The default is 1. | |
$pagesize | number | Number of results per page to return. Typically provided along with the $page parameter. | |
$orderBy | string | Determines which property to use for sorting and the direction in which to sort the data. If you don't provide the $orderBy parameter, the results are sorted by createdDate in ascending order. | |
startdate | string | Start date of the date range to search for security events. If you don't provide a start date, the default value is today minus 30 days. The startdate must be before the enddate. | |
enddate | string | End date of the date range to search for security events. If you don't provide an end date, the default is today. The enddate must be after the startdate. |
Status | Name | Type | Description |
---|---|---|---|
200 | OK | ||
id | number | ID of the audit event. | |
createdDate | datetime | Creation date of the audit event. | |
memberId | number | Member ID associated with the audit event. | |
enterpriseId | number | Enterprise ID or parent to which the member belongs. | |
employee | object | User associated with the audit event. | |
objectType | object | Type of object used to describe the audit event. | |
operation | object | Action taken against the objectType. | |
object | object | Additional information about the audited object. Can contain an ID, the name of the object, or both. | |
transactionId | guid | Unique value to identify the transaction in which the audit event was captured. | |
400 | Bad request. | ||
Message | string | Error message. | |
ErrorCode | number | Error code for the exception. | |
Documentation | string | Documentation for the error. | |
401 | Invalid access token or tenant-specific endpoint. | ||
Message | string | Error message. | |
ErrorCode | number | Error code for the exception. | |
Documentation | string | Documentation for the error. |
- Permission: Audit Logging | API Access
- Scope: Data | Tracking Event | Read
- Salesforce Help: Audit Trail