HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
Product Docs

Explore - Transactions and workbook agent

Use the Transactions Explore to build custom reports on gateway activity, payment failures, fraud signals, and geographic trends — with an AI-powered Workbook Agent for plain-language querying.

The Transactions Explore gives you a flexible, queryable view of every transaction processed through your gateways — including linked invoices, line items, and fraud signals. Build tailored reports manually using the field picker, or let the AI-powered Workbook Agent construct and run queries from plain-language questions.
Not included in Starter or Pro — contact Recurly Sales to upgrade

Prerequisites

  • Users must have the Analytics user role permission.

Definition

The Transactions Explore is a dynamic, flexible reporting tool that gives you a custom view of all transactions processed through your gateways, along with corresponding invoices and line items. Use it to query transaction outcomes, monitor fraud signals, analyze geographic payment patterns, and correlate transaction data with subscription and account records. It's designed for gateway and payment analysis — not accounting purposes, which are better handled by the Invoices Explore.

Key benefits

Detailed transaction insights Get a comprehensive view of all transactions to gain deeper insight into your payment processes and make more informed decisions.
Customizable gateway reports Build tailored reports to track gateway activity, failures, and payment trends — giving you more control over your financial operations.
Streamlined fraud monitoring Get a clear view of multiple fraud line items with seamless Kount fraud integration data alongside your transaction records.
✦ AI-assisted analytics Use the Workbook Agent to ask data questions in plain language. The agent interprets your question, selects the relevant fields, and returns a result set or chart.

Key details

The Transactions Explore includes all transactions processed through a gateway, along with corresponding invoices and line items. It does not include all invoices or charge items. Multiple transactions may be associated with a single invoice, and multiple lines may be included for a given transaction when multiple fraud line items are returned from a Kount fraud integration.

NoteThe Transactions Explore is intended for gateway activity, failure analysis, and payment reporting — not accounting. Use the Invoices Explore for accounting purposes.

Explore interface

The Explore is divided into three panels:

PanelDescription
Left panel — Workbook AgentAsk natural-language questions about your transaction 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.
Right panel — Results areaToggle between Results (table view), Chart (visualization), or Both. Use the Options tab to configure axes, grouping, and chart type. Click Preview to run a sample query and verify your field selection before committing.

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 failed transactions in the last 7 days grouped by failure reason"
  • "What is the total transaction volume by country this month?"
  • "Which credit card types have the highest decline rates?"
  • "List transactions flagged for fraud in the past 30 days"
  • "Break down successful transactions by plan and subscription state"

You can use the Agent and the field picker together. After the agent populates a query, you can add or remove fields manually using the center panel — changes are reflected immediately in the results view.

Opening an existing report

1

Open the document browser

Click the yellow Recurly logo in the upper left corner of the Explore.

2

Navigate to your report

Go to My documents for private personal reports and folders, or the Hub for the shared workspace for your entire site. Click the folder or report to open it.

3

Edit the report

Select File > Edit or click the Edit button in the upper right corner.

4

Save your changes

Select File > Save to save your updates.

Running or refreshing a report

1

Open the View menu

In an existing report, select the View menu to access run and refresh options.

2

Choose your refresh mode

Select Refresh to load cached results (re-queries only if the cache has expired or fields have changed), or Refresh w/o cache to bypass stored results and pull live, up-to-the-minute data directly from your data source.

Creating a new report

1

Select your fields

Browse the field catalog in the center panel. Fields are grouped by data topic — click any field to add it to your active query. Use the In-use filter to see only your current selection.

2

Preview your results

Click Preview to run a sample query and verify your field selection before committing — especially useful for large result sets.

3

Choose your view

Toggle between Results (table view), Chart (visualization), or Both. Use the Options tab to configure axes, grouping, and chart type.

Saving a new report

1

Open the Save dialog

In the workbook, click File > Save.

2

Name your document

Give the document a name and an optional description.

3

Choose a location

Use the Locations browser to find and select the folder you want to save the document to. The document can be moved after saving if needed.

4

Save

Click Save to save the document.

Available data

The field picker organizes all available dimensions and metrics by topic. Each topic maps to a set of underlying data entities:

Data topicDescription
Billing infoPayment method details, billing address, and card metadata associated with accounts.
AccountsAccount-level attributes including account code, email, address, and name.
Business entitiesLegal entity data for multi-entity merchants, including entity name and tax region.
CountryCountry-level geographic dimensions for filtering and grouping transaction data by region.
Credit cardCard brand, card type (debit/credit), issuing bank, last four digits, and expiration data.
Dunning infoRetry attempts, dunning state, and communication timing for failed payment recovery.
Fraud infosFraud risk scores, decision outcomes, and signals returned by Recurly's fraud detection layer.
Invoice line itemsIndividual charges and credits at the line level, including unit amounts, quantities, and product codes.
InvoicesInvoice totals, state (open, collected, failed, voided), currency, and dates.
OperationsInternal processing metadata including gateway response codes and operation type.
PlansPlan codes, names, intervals, and pricing tiers.
SubscriptionsSubscription state, start/end dates, trial info, and associated plan and add-on metadata.
Transaction statusesStandardized transaction outcome states: success, declined, error, voided, and more.
Transaction_Geo (maps)Geographic coordinates and region data for map-based transaction visualizations.
TransactionsCore transaction fields: amount, currency, type (purchase, refund, void), gateway, and timestamp.

Tips and best practices

  • Use Preview before adding many fields to confirm the data shape and avoid slow load times on large result sets.
  • The In-use toggle in the field picker narrows the view to your current selection, making it easier to audit what's included before running a query.
  • Combine the Transaction statuses topic with Credit card or Country to identify regional or card-type-specific decline patterns.
  • Use the Fraud infos topic alongside Transactions to correlate fraud signals with transaction outcomes — useful for investigating dispute spikes.
  • For high-volume date ranges, start with aggregated metrics (totals, counts, rates) before drilling into row-level detail to keep performance fast.
  • Save frequently used queries as a dashboard using the + Dashboard button in the top-right corner so teammates can access them without rebuilding.
  • The Workbook Agent works best with scoped, specific questions. Include a timeframe, a transaction outcome (e.g., failed, declined), and at least one grouping dimension for the most precise results.


Did this page help you?