Running Ad-Hoc Operational Data Exports

You can quickly set up and run a one-off, ad-hoc data export containing operational data of selected entities in your Organization - such as Bills, Prepayments/Commitments, Accounts, and Balances. The data export will contain the operational data for the selected entities at the time the export runs.

Important!

  • Reviewing Operational Data Export Options. Before attempting to run and ad-hoc operational data export, please review the options available for controlling the data the export will contain - see Working with Operational Data Export Schedules.

  • Data Export Entity Schema! You can review the details of export schema for each entity available for operational data export - see Data Export Entity Schema.

To create an ad-hoc Operational Data export:

1. Select Data exports:

The Data export page opens.

2. On the Export schedules panel, select Run ad-hoc export. The Run ad-hoc export page opens.

3. Enter the Ad-hoc export details:

  • Destinations. Use the drop-down to select the Export destinations to be used for the ad-hoc data export:

  • Export file format. Select the format you require for the data export files:

    • CSV. (Default).

    • JSON.

  • Source type. Select the Operational data option. The page adjusts to allow you to select a Time period for the export and the Operational data entities you want the export to contain.

4. Time period. Define a time period using an inclusive start date and exclusive end date you want the ad-hoc data export to cover. This controls the range of operational data that the export will contain - only data created or modified in the time period will be included:

  • All Time. Unrestricted and the export contains all the operational data available for selected entities. (Default setting)

  • Custom. Use the date/time selectors to define a specific period.

  • Today. Data for the current day up until the date and time (to the minute) the selection is made. For example, if you make the selection at 10:30 a.m. UTC, the export will contain the operational data up until 10:30 a.m. UTC of the current day.

  • Yesterday. Data for the day before the export runs - that is, the 24 hour period from midnight start to midnight end of the day before.

  • Week, Month, or Year to date. Data for the period covering the current week, month, or year to the date and time (to the minute) the selection is made.

    • For example if Week to date is selected, weeks run Monday to Monday. If the selection is made at 10:30 a.m. UTC on October 16th 2024, which is a Wednesday, it will contain all operational data for the period starting Monday October 14th 2024 through to the Wednesday at 10:30 a.m. UTC of the current week.

  • Previous week, month, quarter, or year. Data for the previous full selected period. For example, if Previous week is selected, weeks run Monday to Monday. If the export is ran on June 12th 2024, which is a Wednesday, the export will contain data for the previous week period running from Monday, June 3rd to end of day on Sunday, June 9th 2024.

  • Last 7, 30, 35, 90, or 120 days. Data for the selected number of days prior to the date the export is ran. For example, if Last 30 days is selected and the export is ran at any time on June 15th 2024, it will contain operational data for the previous 30 days - starting May 16th 2024 through to end of day on June 14th 2024.

  • Last year. Data for the full year prior to the date the export is ran.

When you select the Time period, the inclusive start date and exclusive end date are shown in brackets. For example, if Previous week is selected on March 6th 2025:

5. Under Operational data entities, select the plus icon and use the pop-up to select the entities whose data you want to include in the ad-hoc export:

  • Accounts

  • Account Plans

  • Aggregations

  • Balances

  • Balance Transactions

  • Bills

  • Bill line items

  • Prepayments/Commitments

  • Compound Aggregations

  • Contracts

  • Meters

  • Plans

  • Plan Groups

  • Plan Group Links

  • Plan Templates

  • Pricing

  • Pricing Bands

  • Products

Tip: Exporting data for all entities? If you want to export the operational data for all entities, use Select all.

6. Select Add. The selected entities are added to the Ad-hoc export details.

7. When you have entered all details for the ad-hoc data export, select Run ad-hoc export:

  • In this example for an ad-hoc export to run on March 6th 2025, we've selected to include the operational data for any Accounts and Bills created or modified in the previous week to be included.

An Export job is scheduled for the ad-hoc operational data export and you can check if the job succeeded on the Export jobs page - see Reviewing Export Jobs.

Next: Downloading Data Export Files Locally



Additional Support

Login to the Support portal for additional help and to send questions to our Support team.