AuditLogitems API V2 call
You can use the AuditLogItems API call to retrieve a filtered list of audit log entries, and to retrieve a particular audit log entry.
Retrieving a particular audit log entry
Retrieving multiple audit log entries
The following parameters are used within the AuditLogItems API call:
The base address of the API. For more information, see API access options .
|entryID||The unique identifier for an audit log entry. Audit log entry IDs are returned by the AuditLogItems call.|
|filterCriteria||The criteria used to filter the search results. This is a required parameter. For details, see Filtering the results (below).|
Filtering the results
When retrieving multiple audit log entries, you must include filter criteria. You can filter the results by specifying a filter object, by specifying a start and/or end date, and by specifying a set of audit log entry ids. You can combine multiple filter criteria to further narrow the results.
Specifying a filter object
Specifying a filter object allows you to filter the audit log entries by a particular customer, event, event registration, invoice, payment, refund, or donation.
where objectType can be Customer, Event , EventRegistration, Invoice, Payment, Refund, or Donation, and objectID is the unique identifier of the customer, event, event registration, invoice, payment, refund, or donation.
Specifying a start or end document date
You can filter the audit log entries by specifying a start date and/or an end date (using the DocumentDate field).
where date is the start or end date of the range (using the yyyy-mm-dd date format).
Specifying a set of audit log entries
You can filter the audit log entries by specifying a set of audit log entries.
where id is the unique identifier of an audit log entry.
Using the $skip and $top parameters, you can retrieve audit log entries in sets or pages. You use the $top parameter to specify the maximum number of entries to be returned, and the $skip parameter to specify the number of entries to skip. The $skip parameter is incremented each call to return the next set or page of entries.
You want to retrieve 50 entries using an application that can only process 20 records at a time. Using the following calls, the application retrieves the first set of 20 entries, then a second set of 20, and finally, the remaining 10 entries.
In this example, the $top specifies the maximum number of entries to retrieve (20), and the $skip parameter is incremented from 0 to 20 to 40 to skip the entries retrieved by the previous call(s).
For each audit log entry, the AuditLogItems API call retrieves the following information.
|Timestamp||The date and time the entry was created.|
|Contact||The ID and URL of the contact the entry applies to.|
|FirstName||The first name of the contact.|
|LastName||The last name of the contact.|
|The email address of the contact.|
|Organization||The organization of the contact.|
|Message||The message displayed for this audit log entry.|
|Severity||The importance of the message. Possible values are:|
|OrderType||The origin of the audit log entry. Possible values are:|
|Properties||Key/value array with technical information from payment systems. Only returned when retrieving a single audit log entry.|
|ID||The unique identifier of the audit log entry.|
|URL||The URL of the audit log entry.|