Running Ad-Hoc Usage Data Exports - m3ter Documentation

Setting Up and Running Ad-Hoc Usage Data Export

To set up and run an ad-hoc Usage Data Export:

1. Select Data exports:

The Data exports page opens.

2. On the Export schedules panel, select Run ad-hoc export:

The Run ad-hoc export page opens with Usage data selected by default as the Source type.

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:

• Select a destination.

  • If No options shows in the drop-down, you must first create at least one destination before you can set up an ad-hoc data export - see Creating and Managing Export Destinations.
  • Alternatively, if you simply want to download the data export file locally, do not select a Destination. See Downloading Data Export Files Locally for more details.
  • Export file format. Select the format you require for the usage data export files:

• CSV ( Default)

  • JSONL

4. Under Ad-hoc export data:

• Source type. For a usage data ad-hoc export, leave this as the default selection for Usage data.

  • Time period. Define a time period you want the ad-hoc data export to cover. This setting controls the range of usage data the export will contain:

• Custom. Enter start and end date/times to define the time period.

  • Today. Data collected for the current day up until the time the export is run. ( Default setting)
  • Yesterday. Data collected for the day before the export runs - that is, the 24 hour period from midnight to midnight of the day before.
  • Week, Month, Year to date. Data collected for the period covering the current week, month, or year period. For example, for Week to date setting weeks run Monday to Monday - if the export is run at 10 a.m. UTC on October 16th 2024, which is a Wednesday, it will contain all usage data collected starting Monday October 14th 2024 through to the Wednesday at 10 a.m. UTC of the current week.
  • Previous week, month, quarter, year. Data collected for the previous full week, month, quarter, or year period. For example, weeks run Monday to Monday - if the export is run on June 12th 2024, which is a Wednesday, the export will contain data for the period running from Monday, June 3rd to midnight on Sunday, June 9th 2024.
  • Last 12 hours. Data collected for the twelve hour period up to the start of the hour in which the export is run.
  • Last 7 days, 30 days, 35 days, 90 days, 120 days, year. Data collected for the selected period prior to the date the export is run. For example, if Last 30 days and the export is run for any time on June 15th 2024, it will contain usage data collected for the previous 30 days - starting May 16th 2024 through to midnight on June 14th 2024.

• Meters. Add Meters for the data export:

• Select the plus icon. A popup will show listing all Meters in your Organization and you can search the list.

  • Check the Meters whose usage data you want to include in the export and select Add.
  • The export will contain the usage data collected by the Meters you add for the specified Time period. ( Default is All meters)
  • Note that you can search the Meters list by name or enter an ID.

• Accounts. Add Accounts for the data export:

• Select the plus icon. A popup will show listing all Accounts in your Organization and you can search the list.

  • Check the Accounts whose usage data you want to include in the export and select Add.
  • The export will contain the usage data collected by the Meters you’ve added and for the Accounts you add for the specified Time period. ( Default is All Accounts)
  • Note that you can search the Accounts list be name or enter an ID.

5. If you want to use Dimensions filters for the usage data included in the export, select Add dimension filter. A menu appears and lists any Dimension fields for Meters selected for the export:

• In the current example, a single Meter has one Dimension field configured.

6. Select the Meter Dimension field you want to use to filter the data returned for the export. For the current example, we’ll select Data Fields Meter 1 > Data File Type. A dialog replaces the menu, which lists values used for this field when usage submissions were made for the Meter within the selected Time period.
7. Check the values used for the selected Meter Dimension field you want to use to filter the data returned for the export and then select Add filter:

The dialog closes and the select Dimension field values are added under Dimension filters:

8. If you want to apply Aggregations to the usage data returned for export, under Aggregations, select Add aggregation. A menu listing available aggregation methods appears:

9. Select the Aggregation method you want to apply. For example, select Sum. A dialog replaces the menu and shows the fields on the Meters selected for the export which can have this aggregation method applied:

10. Select the Meter data field you want to apply the Aggregation method to. The selection is added under Aggregations.

• For the current example, we’ve applied a Sum Aggregation to the numeric data field on the selected Meter.

11. If you’ve applied Aggregations to the returned usage data for export and you want to group the data, under Aggregations, select the grouped by plus icon. A menu appears:

• In the current example, we select to group by a Time. The menu is replaced by a dialog showing the available options:

12. Select the time period you want to group the data by. The dialog closes and your grouped by selection is added under Aggregations.
13. When you have entered all details for the ad-hoc data export, select Run ad-hoc export:

• In this example, we’ve selected a single Meter and two Accounts for which filtered and aggregated usage data grouped daily will be included in the ad-hoc usage data export.

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