Reports

Overview

Reports allow you to analyze and export your transaction data with custom aggregations and groupings. You can create reports to track payment trends, provider performance, and other business metrics.

Creating a Report

To create a new report:

1. Navigate to the Reports page.
2. Click the New Report button.
3. Enter a descriptive name for the report.
4. Click Create.

The report is created and ready for configuration.

Configuring a Report

Click on a report to open its configuration page. Here you can define:

Report Fields

Fields determine what data is included in the report. Click Add Field to add columns to your report.

Available Standard Fields:

Field	Description
Provider	The provider associated with the transaction
Transaction Type	The type of transaction (e.g., "Appointment")
Payment Amount	The payment amount received
Payout Amount	The payout amount calculated for providers

Custom Metadata Fields:

In addition to standard fields, any custom metadata stored with your transactions is available. These fields are automatically discovered from your imported data.

Field Configuration

For each field, configure:

Field Name The display label for the column in results.

Field Type

• Currency - For monetary values (displays as formatted currency)
• Number - For numeric data
• String - For text or categorical data

Aggregation Type

• Sum Values - Calculates the total sum of all values
• Count Values - Counts occurrences and shows breakdown by unique value

Grouping

Grouping determines how results are organized over time:

Grouping	Description
None	Single aggregation across entire date range
Day	Results grouped by calendar day
Week	Results grouped by week (Monday start)
Month	Results grouped by calendar month

TIP

Use "None" for overall totals. Use "Day", "Week", or "Month" to see trends over time.

Executing a Report

After configuring your report, execute it to generate results:

1. Click the Execute Report button.
2. Select the date range:
   • Relative: Last 30, 60, or 90 days
   • Payout Batch: Use dates from an existing payout batch
   • Custom: Select specific start and end dates
3. Click Run.

The report processes in the background. You'll see a progress indicator and be notified when complete.

Viewing Results

After execution completes:

• Results are displayed as charts and data visualizations
• Sum aggregations show bar charts of totals
• Count aggregations show breakdowns by unique values
• Results are organized by your selected grouping period

Report Examples

Example 1: Monthly Payment Summary

Purpose: Track total payments received each month.

Configuration:

• Field: Payment Amount (Currency, Sum Values)
• Grouping: Month

Result: Bar chart showing total payments for each month in the date range.

Example 2: Transaction Type Distribution

Purpose: See breakdown of transactions by type.

Configuration:

• Field: Transaction Type (String, Count Values)
• Grouping: None

Result: Shows how many transactions of each type occurred.

Example 3: Provider Performance

Purpose: Compare payout amounts across providers.

Configuration:

• Field: Provider (String, Count Values)
• Field: Payout Amount (Currency, Sum Values)
• Grouping: Month

Result: Monthly breakdown of transaction counts and payouts by provider.

Example 4: Service Code Analysis

Purpose: Analyze which service codes are most common.

Configuration:

• Field: tx.details[Service Code] (String, Count Values)
• Grouping: Week

Result: Weekly count of each service code used.

Managing Reports

Editing Reports

Click on any report to modify its configuration. Changes are saved automatically and apply to the next execution.

Re-running Reports

You can execute a report multiple times with different date ranges. Each execution replaces the previous results.

Deleting Reports

To delete a report:

1. Open the report detail page.
2. Click the Delete button.
3. Confirm the deletion.

WARNING

Deleting a report removes all configuration and results. This cannot be undone.

Best Practices

1. Use descriptive names: Name reports clearly (e.g., "Monthly Revenue by Provider" not "Report 1").

2. Start simple: Begin with a single field and add more as needed.

3. Choose appropriate grouping: Match grouping to your analysis needs. Daily for recent activity, monthly for trends.

4. Use relative dates for recurring reports: "Last 30 days" automatically updates each time you run the report.

5. Leverage metadata fields: Custom metadata from your imports can provide valuable insights.

Limitations

• Reports process all transactions in the date range (no additional filtering)
• Only one execution can run at a time per report
• Results are stored as JSON and displayed visually in the interface