Home

Download this help site
(PDF 82MB)

Download

AuditLogitems API V2 call 

Icon

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.

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

Syntax

Example:

Retrieving multiple audit log entries

Syntax

Example:

Parameters

The following parameters are used within the AuditLogItems API call:

Variable

Description

baseAPIaddress

The base address of the API. For more information, see API access options .

accountID

The account identifier that appears on the Account and billing screen and is returned by the Accounts API call.

entryIDThe unique identifier for an audit log entry. Audit log entry IDs are returned by the AuditLogItems call.
filterCriteriaThe criteria used to filter the search results. This is a required parameter. For details, see Filtering the results (below).
Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

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.

Syntax

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:

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

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

Example:

Specifying a set of audit log entries 

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

Syntax 

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

Example: 


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. 

 
 

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

Response fields

For each audit log entry, the AuditLogItems API call retrieves the following information.

Field

Description

TimestampThe date and time the entry was created.
ContactThe ID and URL of the contact the entry applies to.
FirstNameThe first name of the contact.
LastNameThe last name of the contact.
EmailThe email address of the contact.
OrganizationThe organization of the contact.
MessageThe message displayed for this audit log entry.
SeverityThe importance of the message. Possible values are:
  • Undefined
  • Verbose
  • Information
  • AttentionRequired
  • Warning
  • Error
  • Critical
OrderTypeThe origin of the audit log entry. Possible values are:
  • Undefined 
  • MembershipApplication 
  • MembershipRenewal 
  • MembershipLevelChange 
  • EventRegistration 
  • Donation 
  • ChangeBillingPlan 
  • ChangeBillingInfo
PropertiesKey/value array with technical information from payment systems. Only returned when retrieving a single audit log entry.
IDThe unique identifier of the audit log entry.
URLThe URL of the audit log entry.

Sample JSON response

Sample XML response

On this page:   

See also:

  • No labels