Open the Reports tab.
Last updated on
Apr 16, 2026
Alert
This article contains prerelease information. Release dates, features, and other information are subject to change without notice.
Generate scheduled CSV reports to track SMS and WhatsApp usage, monitor quotas, and analyze consumption by group.
Transaction usage exports provide visibility into SMS and WhatsApp activity across your account, including purchased quantities, consumption totals, and group-level usage. These exports include:
- SMS authentication
- SMS delivery
- WhatsApp authentication
- WhatsApp delivery transactions.
Exports are generated as scheduled snapshots, not real-time queries. Use schedules for ongoing monitoring, or manually prepare the export to regenerate it when you need updated data immediately.
How data exports work
Transaction data is exported as CSV files within a defined date range and with specified filters.
- Exports are generated asynchronously and are not real-time.
- Exports are refreshed on a configured schedule.
- Selecting Prepare regenerates the export with the latest available data.
Each row in the CSV represents a single agreement and includes SMS and WhatsApp transaction usage data.
Create a transaction usage report
Create a CSV report from the Reports tab.
-
-
Select New Export.
-
Select Transaction consumption.
-
Define the export:
- Select a date range.
- Apply filters, including one or more Groups if needed.
-
Select Select columns and choose the data to include.
For SMS and WhatsApp transaction usage, expand Add-on in the Available Columns section and include the following:
- Purchased Quantity for Message Delivery Add-On — Total number of transactions purchased.
- Start Date for Message Delivery Add-On — The Annual Effective Date when the transaction quota was applied.
- SMS OTP Consumption Count — Transactions used for SMS-based authentication.
- SMS Agreement Delivery Consumption Count — Transactions used to deliver agreement links via SMS.
- WhatsApp OTP Consumption Count — Transactions used for WhatsApp-based authentication.
- WhatsApp Agreement Delivery Consumption Count — Transactions used to deliver agreement links via WhatsApp.
To enable group-level reporting, also include the Sender Group column.
-
Select Save, and provide a name for the export.
The export is generated asynchronously and appears in the Recent Reports list when complete.
Configure accurate group-level data
Group-level usage requires both filtering and column selection.
- Apply one or more Group filters when defining the export.
- Include the Sender Group column in the export.
If either requirement is not met, group-level usage will not be accurately represented in the exported data.
Ensure accurate contract usage data
To report against the correct contract period:
- Use the Phone Quota Effective (Start) date as the report start date.
- This value is available in: Account Settings > Send Settings
Using the correct start date ensures that all transactions under the current contract are included and that usage totals and group-level summaries are accurate.
Schedule a report
Schedule a report to generate updated transaction data automatically.
-
Create a new export or edit an existing one.
-
Select the ellipsis for the export you want to schedule, and pick Schedule from the dropdown menu.
-
Configure the schedule by defining the:
- Schedule frequency (Daily, Weekly, Monthly)
- What emails to send the report to
- An optional message
-
Save the schedule.
Scheduled reports are generated automatically and can be downloaded from the Recent Reports list or delivered by email.
Update an export with the latest data
To update an export:
- Select Prepare to regenerate the export immediately.
- Or wait for the next scheduled run.
- You can also create a new export with the same parameters if needed.
Download an export using the API
Retrieve the latest generated export using the API.
- Endpoint: POST /api/rest/v6/reportDownload
- Required parameter: scheduleId
This endpoint:
- Requires an export schedule created in the Reports UI.
- Returns the download URL for the most recent CSV file only.
- Does not generate a new export on demand.
If the export has not been updated, the previously generated CSV file is returned.
When downloading large CSV files, processing may take longer because all records must be prepared. Configure a client timeout of at least 5 minutes to ensure successful downloads.
Export availability and retention
- Exported CSV files are stored for 7 days.
- After 7 days, the file expires and is no longer available for download.
- To access updated data, regenerate the export using Prepare or wait for the next scheduled run.
Things to know
- Exports must be created or scheduled before they can be accessed through the API.
- Only the most recent CSV file for a schedule is available through the API.
- Group-level reporting requires both:
- A Group filter
- The Sender Group column
- Using the correct Phone Quota Effective (Start) date is required for accurate contract-level reporting.
- Export files expire after 7 days and must be regenerated if needed.
