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.

NameTypeDescription
$pagenumberPage 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.
$pagesizenumberNumber of results per page to return. Typically provided along with the $page parameter.
$orderBystringDetermines 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.
startdatestringStart 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.
enddatestringEnd 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.
StatusNameTypeDescription
200  OK
 idnumberID of the audit event.
 createdDatedatetimeCreation date of the audit event.
 memberIdnumberMember ID associated with the audit event.
 enterpriseIdnumberEnterprise ID or parent to which the member belongs.
 employeeobjectUser associated with the audit event.
 objectTypeobjectType of object used to describe the audit event.
 operationobjectAction taken against the objectType.
 objectobjectAdditional information about the audited object. Can contain an ID, the name of the object, or both.
 transactionIdguidUnique value to identify the transaction in which the audit event was captured.
    
400  Bad request.
 MessagestringError message.
 ErrorCodenumberError code for the exception.
 DocumentationstringDocumentation for the error.
    
401  Invalid access token or tenant-specific endpoint.
 MessagestringError message.
 ErrorCodenumberError code for the exception.
 DocumentationstringDocumentation for the error.

These permissions are required.

  • Permission: Audit Logging | API Access
  • Scope: Data | Tracking Event | Read