HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
Product Docs

Site activities export

Overview

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

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.

🚧

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.

📘

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.


Accessing the site activities export

  1. Go to the Admin section of Recurly.
  2. In the left-side panel, navigate to the "Admin Exports" option,
  3. Select "Site Activities" from the list of available exports.

Explore interface

The Explorer is divided into three areas:

Interface AreaDescription
Left panel -WorkbookAgent Ask natural-language questions about your invoice data. The agent suggests fields and runs queries on your behalf.
Center panel - Field pickerBrowse and search the full field catalog. Fields are grouped by topic. Click any field to add it to your active query. Use the In-use filter to see only selected fields.

Pre-built sample queries

  • List of site activities - Returns a row-level list of all site activity events within the active date scope, including actor, action type, affected object, and timestamp.
  • Count of site activities - Returns a grouped count of site activity events broken down by activity type, giving a quick summary of the most common actions across your site.

Using the Workbook Agent

The Workbook Agent is the fastest way to start an analysis. Type a question in the text box at the bottom of the left panel and press Enter (or click the send icon).

Example prompts:

  • “Show me all activity on account ABC123 in the last 14 days”
  • “Which actors made the most changes to accounts this month?”
  • “List all subscription cancellations performed via API in the past 30 days”
  • “Count account activities by type for the current revenue period”
  • “Show me all activities where the acted-upon object is a billing info record”

Available Fields

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:

FieldExampleDescriptionData type (max size)
eventplanThe type of event that triggered the entry in the audit log.String (—)
resource_identifierdruuid-1234...The external UUID of the record that was audited. Typically, the druuid of the record_id.String (—)
resource_typeplanThe external type of the record that was audited.String (—)
target_resource_identifierdruuid-5678...The external UUID of the target of the record.String (—)
target_resource_typesiteThe external type of the target of the record.String (—)
principal_resource_identifier[email protected] or api-key-nameThe external identifier of the principal. This could be the email or API key name/masked value.String (—)
principal_resource_typeuser or api_keyThe external type of the principal.String (—)

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.

Plan events are supported in both the Admin UI and API v3.

EventActionsTrigger
loginsuccessSuccessful login from a user to the merchant site
usercreate, delete, updateA user is added, roles updated or removed from the site
rolecreate, update, deleteA new role is created, updated or removed from a site
account_updaterenable, 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. Supported in Admin UI and API v3. 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. Supported in Admin UI and API v3.
measured_unitcreate, update, deleteA measured unit is added, updated or removed from a site.
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. Supported in Admin UI and API v3.
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.

Creating a new report

  1. Browse and search the full field catalog. Fields are grouped by data topic.
  2. Click any field to add it to your active query. Use the In-use filter to see only selected fields.
  3. Toggle between Results (table view), Chart (visualization), or both.
  4. Use the Options tab to configure axes, grouping, and chart type.

Filtering your data

  1. Standard Filters: Drag and drop any field into the Filters section of the query builder, or click the drop-down/actions menu next to the field header in your data view and select Filter.
  2. Filtered Measures: To create a measure that is specifically tied to one dimension (e.g., Acted Type by Actor Name), create a pivot table with your target metric and the dimension. Right-click the measure under a specific pivot value and select Create filtered measure.

Downloading your data

To download your activity data, from the menu, select Tab - Download. You can choose from several file format options including CSV, Excel and JSON.