ExportSchedule
Create Schedule
Create a new Data Export Schedule. Each Schedule can be configured for exporting only one of either Usage or Operational data:
Operational Data Exports.
- Use the operationalDataTypes parameter to specify the entities whose operational data you want to include in the export each time the Export Schedule runs.
- For each of the entity types you select, each time the Export Schedule 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 export each time the Export Schedule runs.
- 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.
Request and Response schema:
- Use the selector under the sourceType parameter to expose the relevant request and response schema for the source data type.
Request and Response samples:
- Use the Example selector to show the relevant request and response samples for source data type.
post/organizations/{orgId}/dataexports/schedules
Path parameters
orgIdstring required
UUID of the organization
Request body
Response
Returns the created Export Schedule