Follow

AuditLogItems admin API 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.

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

AuditLogItems API functions

The AuditLogItems API call supports the following functions. To view the Swagger documentation, click the appropriate function below.

Specifying filter criteria

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.

Syntax
GET [baseAPIaddress]/v2.1/Accounts/[accountID]/AuditLogItems/?FilterObjectType=[objectType]&FilterObjectId=[objectID]

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.

Example:
GET https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?FilterObjectType=Event&FilterObjectId=51377

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).

Syntax
GET [baseAPIaddress]/v2.1/Accounts/[accountID]/AuditLogItems/?StartDate=[date]&EndDate=[date]

where date is the start or end date of the range (using the yyyy-mm-dd date format).

Example:
GET https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?StartDate=2016-11-01&EndDate=2016-11-30

Specifying a set of audit log entries

You can filter the audit log entries by specifying a set of audit log entries.

Syntax
GET [baseAPIaddress]/v2.1/Accounts/[accountID]/AuditLogItems/?ids=[id1],[id2],[id3]...

where id is the unique identifier of an audit log entry.

Example:
GET https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?ids=2525543,2525544

Paging

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.

Example

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.

https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?FilterObjectType=Event&FilterObjectId=51377&$skip=0&$top=20
https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?FilterObjectType=Event&FilterObjectId=51377&$skip=20&$top=20
https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?FilterObjectType=Event&FilterObjectId=51377&$skip=40&$top=20

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).

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

About results ( seconds) Sort by: 
Sorry, an error occured when performing search.