Sign in
ExportAdHoc

Trigger data export.

Trigger an ad-hoc Data Export. Each ad-hoc Export can be configured for exporting only one of either Usage or Operational data:

Operational Data Exports.

  • Entity Types. Use the operationalDataTypes parameter to specify the entities whose operational data you want to include in the ad-hoc export.
  • Export Files. For each of the entity types you select, when the ad-hoc export runs a separate file is compiled containing the operational data for all entities of that type that exist in your Organization

Usage Data Exports.

  • Select the Meters and Accounts whose usage data you want to include in the ad-hoc export.
  • You can use the dimensionFilters parameter to filter the usage data returned for export by adding specific values of non-numeric Dimension data fields on included Meters. Only the data collected for the values you've added for the selected Dimension fields will be included in the export.
  • You can use the aggregations to apply aggregation methods the usage data returned for export. This restricts the range of usage data returned for export to only the data collected by aggregated fields on selected Meters. Nothing is returned for any non-aggregated fields on Meters. The usage data for Meter fields is returned as the values resulting from applying the selected aggregation method. See the Aggregations for Queries - Options and Consequences for more details.
  • If you've applied aggregations to the usage returned for export, you can then use the groups parameter to group the data by Account, Dimension, or Time.

Date Range for Operational Data Exports. To restrict the operational data included in the ad-hoc export by a date/time range, use the startDate date/time request parameter to specify the start of the time period. The export will include all operational data from the specified startDate up until the date/time the export job runs.

Date Range for Usage Data Exports. To restrict the usage data included in the ad-hoc export by date/time range, use the startDate and endDate date/time parameters:

  • Both startDate and endDate are required.
  • endDate must be after startDate.
  • endDate cannot be after tomorrow at midnight UTC. For example if today is May 20th 2025, you can only choose endDate to be equal or before 2025-05-21T00:00:00.000Z.

NOTE: You can use the ExportJob id returned to check the status of the triggered ad-hoc export. See the ExportJob section of this API Reference.

post/organizations/{orgId}/dataexports/adhoc

Path parameters

orgIdstring required

UUID of the organization

Request body

OR

Response

Returns the job id for the ah-hoc data export.

jobIdstring

The id of the job

Changes

Changed in 4 of the 10 revisions of this API.447

  • ac93d1a9e6d921See the full diff
    • ▲

      removed the enum value JSON of the request property anyOf[AdHocOperationalDataExportConfigurationRequest]/allOf[AdHocDataExportConfigurationRequest]/exportFileFormat/allOf[ExportFileFormat]/

      request-property-enum-value-removed

    • ▲

      removed the enum value JSON of the request property anyOf[AdHocUsageDataExportConfigurationRequestV2]/allOf[AdHocDataExportConfigurationRequest]/exportFileFormat/allOf[ExportFileFormat]/

      request-property-enum-value-removed

    • ○

      added the new CHARGES enum value to the request property anyOf[AdHocOperationalDataExportConfigurationRequest]/operationalDataTypes/items/

      request-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9f9e5f3dbde712See the full diff
    • ▲

      removed AdHocOperationalDataExportConfigurationRequest AdHocUsageDataExportConfigurationRequest from the request body oneOf list

      request-body-one-of-removed

    • ○

      added AdHocOperationalDataExportConfigurationRequest AdHocUsageDataExportConfigurationRequestV2 to the request body anyOf list

      request-body-any-of-added

    • ○

      mapped value for key USAGE changed from AdHocUsageDataExportConfigurationRequest to AdHocUsageDataExportConfigurationRequestV2 from the request discriminator

      request-body-discriminator-mapping-changed

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d064a12d0d93143See the full diff
    • ▲

      the request's body type/format changed from object/ to /

      request-body-type-changed

    • ●

      removed AbstractRequest from the request body allOf list

      request-body-all-of-removed

    • ●

      removed the request property destinationIds

      request-property-removed

    • ●

      removed the request property exportFileFormat

      request-property-removed

    • ●

      removed the request property sourceType

      request-property-removed

    • ○

      added request discriminator

      request-body-discriminator-added

    • ○

      the request property oneOf[AdHocUsageDataExportConfigurationRequest]/timePeriod became optional

      request-property-became-optional

    • ○

      added the new BALANCE_TRANSACTIONS enum value to the request property oneOf[AdHocOperationalDataExportConfigurationRequest]/operationalDataTypes/items/

      request-property-enum-value-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b51See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog