Site activities export

Harness the power of Recurly's Site Activities export to monitor, track, and analyze site-level activities, ensuring transparency and control over your Recurly site's operations.

Overview

Required plan

This feature is currently available for all merchants on an Elite Recurly plan, with an Admin role, or an Admin permission included in their role. To adopt this feature onto your Elite site, you will need to create a support request or contact your CSM to have the feature enabled. This export is also available as an optional add-on for customers on Recurly's Starter and Professional plans. Please reach out to Support or your CSM for more information.

Recurly's Site Activities export is a comprehensive tool designed to capture and log activities related to your Recurly site. Unlike the Account Activities export, which focuses on customer account-level actions, the Site Activities export zeroes in on changes and actions pertaining to the Recurly site itself. This includes, but is not limited to, plan modifications, site setting updates, user management alterations, and user login activities.

🚧

Please Note

The Site Activities export will only display data from activities conducted after the Site Activities feature flag is turned on in your site. It will not reflect historic events that pre-date the log becoming active on your Recurly site.

This export will only support data retention for 12 months. After data has been available for 12 months, it will no longer be accessible in this export. If you require data retention past 12 months, it is recommended that you back up your data in your own data system.

Key details

Field definitions

The fields below are the fields or columns that can be added to your dashboard through filtering. You can decide which of the metadata types below you would like to view for the corresponding entries (objects with activities).

Each entry in the Site Activities export is characterized by specific fields or columns, which can be customized through filtering. Here's a breakdown of the metadata types available:

FieldDefinition
eventThe type of event that triggered the entry in the audit log.
resource_identifierThe external UUID of the record that was audited. Typically, the druuid of the record_id.
resource_typeThe external type of the record that was audited.
target_resource_identifierThe external UUID of the target of the record.
target_resource_typeThe external type of the target of the record.
principal_resource_identifierThe external identifier of the principal. This could be the email or API key name/masked value.
principal_resource_typeThe external type of the principal.

Entries

The table below showcases the change activities and their corresponding objects that Recurly logs and makes available through this report. Recurly continues to expand the objects captured within this report. If there are any Recurly objects not represented below but you wish to obtain their event action, please contact your CSM for further guidance.

EventActionsTrigger
loginsuccessSuccessful login from a user to the merchant site
user create, delete, updateA user is added, roles updated or removed from the site
role create, update, deleteA new role is created, updated or removed from a site
account_updater enable, disable, updateAccount updater settings changed on the site.
analytics_settingsupdateThe analytics dashboard settings are updated.
coupon_settingsupdateThe site-wide coupon settings are updated.
currency_settingsupdateCurrencies the site has enabled are updated.
hosted_page_settingsupdateThe site-wide HPP settings are updated.
hosted_account_management_settingsupdateThe site-wide HAM settings are updated.
invoice_settingsupdateThe site-wide invoice settings are updated.
tax_settingsupdateThe site-wide tax settings are updated.
custom_field_definitioncreate, update, deleteA custom field definition is added, updated or removed from a site.
avalara_credentialscreate, update, deleteAvalara credentials are added, updated or removed from a site. Schema notes: Excludes the system marking credentials invalid. User updates only.
plancreate, update, deleteA plan is added, updated or removed from a site. Admin UI only. Schema notes: Excludes plan email configuration.
Needs update to use dunning campaign code
add_oncreate, update, deleteAn add on is added to a plan, updated or removed from a plan. Admin UI only. Schema notes: Needs update to use measured unit codes
couponcreate, updateA coupon is added, updated or removed from a site. Admin UI only.
coupongenerate_codesGenerate more unique coupon codes. Admin UI only.
couponexpire, restoreA coupon is manually expired or restored on a site. Admin UI only.
unique_coupon_codeexpire, restoreA unique coupon code is manually expired or restored on a site. Admin UI only.
email_settingsupdateEmail settings for a template are updated.
email_templatescreate, update, delete, resetEmail templates are created, updated, deleted or reset. Schema notes: Excludes audience selector and attachment changes
payment_gatewayscreate, update, deleteA payment gateway is created, updated or removed from a site. Schema notes: Excludes changing default gateways
dunning_campaigncreate, update, disable, enableA dunning campaign is added, updated, disabled or re-enabled on a site. Admin UI only.
Schema notes: Excludes auditing plans dunning campaign id when changed
dunning_campaign_settingsupdateThe site wide dunning campaign settings are updated. Admin UI only.
itemcreate, update, disable, enableAn item is created, updated, disabled or re-enabled on a site. Admin UI only.
entitlementcreate, update, deleteAn entitlement configuration is created, updated or removed from a site.
business_entitycreate, update, deleteA business entity is created, updated or removed from a site. Admin UI only.
Schema notes: Does not include auditing the creation of new Recurly revenue recognition GL accounting codes.
site_settingsupdateGeneral Site configuration settings are updated.
invoice_templatecreate, updateAn invoice template is created or updated.
webhook_endpointcreate, update, delete, pause, resumeA Webhooks notification endpoint was created, updated, deleted, paused or resumed on a site.
Schema notes: Excludes changing pre-renewal webhook settings.
api_keycreate, view, update, regenerate, deleteA private API key is added, details are updated, it is regenerated or deleted on a site.
public_keyregenerateThe public key has been regenerated on a site.
shipping_methodcreate, update, deleteA shipping method is created, updated or deleted on a site Admin UI only, Schema notes: excludes Recurly revenue recognition fields
apple_pay_settingsupdateApple Pay configuration settings are updated on a site.
Schema notes: Excludes managed Apple Pay domains

📘

Recurly Revenue Recognition

At this time we do not log site activities for Recurly RevRec. No revrec-related data will be included in the Site Activities export.

Implementation guide

1. Accessing the Site Activities export

  1. Login to your Recurly account.
  2. You must have a Site Admin role, or an Admin permission included in your role to access the Admin Exports page on Recurly. Navigate to the “Admin” section located on the navigation panel.
  3. Click on the “Admin Exports” tab.
  4. Here, you'll find the Site Activities option. Click on it to access the log.

2. Filtering the log entries

  1. Once inside the Site Activities Export, you'll see various filtering options at the top.
  2. Choose the desired date range to narrow down the log entries.
  3. Use the metadata types dropdown to select specific fields you wish to view.
  4. Click on “Apply Filters” to update the log based on your selected criteria.

3. Viewing specific log details

  1. Scroll through the log to find entries of interest.
  2. Click on any entry to expand it and view detailed information.
  3. Here, you'll see details like the event type, resource identifier, principal resource type, IP address, and more.

4. Exporting the log

  1. After filtering and selecting the desired log entries, locate the “Export” button at the top right corner.
  2. Click on it and choose your preferred file format (e.g., CSV, Excel).
  3. The download will start automatically. Save the file to your desired location on your computer.

5. Interpreting the log

  1. Open the exported file using the appropriate software (e.g., Microsoft Excel for .xlsx files).
  2. The columns represent the different fields like event, resource identifier, and more.
  3. Review the entries to understand the changes and actions taken on your Recurly site.

6. Taking action based on log insights

  1. Based on the insights from the log, identify any unusual or unauthorized activities.
  2. If you spot any suspicious activity, consider updating user permissions or changing passwords.
  3. For any changes or actions you don't recognize, reach out to the respective team members for clarification.

7. Regular monitoring

  1. Make it a habit to regularly check the Site Activities export to stay updated on all site-level activities.
  2. Set reminders or schedule periodic reviews to ensure you don't miss out on any critical updates or changes.

8. Seeking assistance

  1. If you encounter any challenges or have questions about specific entries, reach out to Recurly's support team.
  2. For feature requests or feedback on the Site Activities export, contact your CSM.

By following these steps, you can effectively utilize the Site Activities export to monitor, track, and analyze activities on your Recurly site, ensuring transparency, security, and operational efficiency.