Dataexports - m3ter Documentation

List ExportDestinations

Function name: m3ter_ListDestinations Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of Export Destination entities. You can filter the list of Destinations returned by UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create ExportDestination

Function name: m3ter_PostDestination Category: WRITE HTTP method: POST Destination: m3ter Create a new Export Destination to use for your Data Export Schedules or Ad-Hoc Data Exports. Currently, two options for setting up Data Export Destinations are available:

S3 buckets on your AWS account.
Buckets in your Google Cloud Storage account.

Request and Response schema:

Use the selector under the destinationType parameter to expose the relevant request and response schema for the type of Destination.

Request and Response samples:

Use the Example selector to show the relevant request and response samples for the type of Destination.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List Jobs

Function name: m3ter_listJobStatuses Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of Export Job entities.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids,scheduleId,status,dateCreatedStart,dateCreatedEnd

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List Schedules

Function name: m3ter_listSchedules Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of Data Export Schedules created for your Organization. You can filter the response by Schedules ids. The response will contain an array for both the operational and usage Data Export Schedules in your Organization.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create Schedule

Function name: m3ter_CreateSchedule Category: WRITE HTTP method: POST Destination: m3ter 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.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Get Data Export File Download URL

Function name: m3ter_GenerateDataExportFileDownloadUrl Category: READ HTTP method: GET Destination: m3ter Returns a presigned download URL for data export file download based on the jobId provided. If you omit destinationIds when setting up your Ad-Hoc data exports or Scheduled data exports, then the data is not copied to a destination but is available for you to download using the returned download URL. Constraints:

Only valid for Export jobs ran in the past 24 hours.
The download URL is time-bound and is only valid for 15 minutes.

NOTE! This ExportDestination endpoint is available in Beta release version. See Feature Release Stages for Beta release definition.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`jobId`	jobId	LookupParameter	Yes	The job ID	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Job

Function name: m3ter_GetJob Category: READ HTTP method: GET Destination: m3ter Retrieve an Export Job for the given UUID. The response returns:

The source type for the data exported by the Export Job: one of USAGE or OPERATIONAL.
The status of the Export Job.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Job to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve ExportDestination

Function name: m3ter_GetExportDestination Category: READ HTTP method: GET Destination: m3ter Retrieve an Export Destination for the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the ExportDestination to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update ExportDestination

Function name: m3ter_PutDestination Category: WRITE HTTP method: PUT Destination: m3ter Update an Export Destination for the given UUID. Currently, two options for setting up Data Export Destinations are available:

S3 buckets on your AWS account.
Buckets in your Google Cloud Storage account.

Request and Response schema:

Use the selector under the destinationType parameter to expose the relevant request and response schema for the type of Destination.

Request and Response samples:

Use the Example selector to show the relevant request and response samples for the type of Destination.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Export Destination to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete ExportDestination

Function name: m3ter_DeleteDestination Category: WRITE HTTP method: DELETE Destination: m3ter Delete an Export Destination for the given UUID. NOTE: If you attempt to delete an Export Destination that is currently linked to a Data Export Schedule, an error message is returned and you won’t be able to delete the Destination.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Export Destination to delete.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Schedule

Function name: m3ter_GetSchedule Category: READ HTTP method: GET Destination: m3ter Retrieve a Data Export Schedule for the given UUID. Each Schedule can be configured for exporting only one of either Usage or Operational data.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Schedule to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update Schedule

Function name: m3ter_UpdateSchedule Category: WRITE HTTP method: PUT Destination: m3ter Update a Data Export Schedule for the given UUID. 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.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Schedule to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete Schedule

Function name: m3ter_DeleteSchedule Category: WRITE HTTP method: DELETE Destination: m3ter Delete the Data Export Schedule for the given UUID. Each Schedule can be configured for exporting only one of either Usage or Operational data.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Schedule to delete.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Trigger data export.

Function name: m3ter_TriggerDataExport Category: WRITE HTTP method: POST Destination: m3ter 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.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

​List ExportDestinations

​Parameters

​Exits

​Create ExportDestination

​Parameters

​Exits

​List Jobs

​Parameters

​Exits

​List Schedules

​Parameters

​Exits

​Create Schedule

​Parameters

​Exits

​Get Data Export File Download URL

​Parameters

​Exits

​Retrieve Job

​Parameters

​Exits

​Retrieve ExportDestination

​Parameters

​Exits

​Update ExportDestination

​Parameters

​Exits

​Delete ExportDestination

​Parameters

​Exits

​Retrieve Schedule

​Parameters

​Exits

​Update Schedule

​Parameters

​Exits

​Delete Schedule

​Parameters

​Exits

​Trigger data export.

​Parameters

​Exits

List ExportDestinations

Parameters

Exits

Create ExportDestination

Parameters

Exits

List Jobs

Parameters

Exits

List Schedules

Parameters

Exits

Create Schedule

Parameters

Exits

Get Data Export File Download URL

Parameters

Exits

Retrieve Job

Parameters

Exits

Retrieve ExportDestination

Parameters

Exits

Update ExportDestination

Parameters

Exits

Delete ExportDestination

Parameters

Exits

Retrieve Schedule

Parameters

Exits

Update Schedule

Parameters

Exits

Delete Schedule

Parameters

Exits

Trigger data export.

Parameters

Exits