REST API Reference

Back Next

Requesting asset-level data

You can run a job to export metering data by asset.

After the job starts, you can check the job status. For more information, see Getting the metering data export job status.

When the job completes successfully, you can send a request to download the data. The data file includes the following columns:

Meter ID

Meter Name

Date

Asset Name

Asset Type

Project

Folder

Org ID

Org Type

Environment Name

Environment Type

Tier

IPU Per Unit

Usage

Consumption (IPUs)

POST request

To send the export job request, use the following URI:

/public/core/v3/license/metering/ExportMeteringData

The following table describes the fields to include in the request:

Field	Type	Required	Description
startDate	String	Yes	Start of the date range in ISO 8601 format. For example, 2022-08-12T00:00:00Z
endDate	String	Yes	End of the date range in ISO 8601 format. When you request asset-level data, the range can be a maximum of 30 days.
meterId	String	-	Meter ID. When you export asset-level data, you can export data for a single meter. By default, data for all meters is included.
jobType	String	Yes	Type of metering data to export. Use ASSET.
callbackUrl	String	-	A valid, publicly available URL where the service posts the job status.

POST request example

You might use a request similar to the following example:

{
    "startDate":"2024-08-12T00:00:00Z",
    "endDate":"2024-09-12T00:00:00Z",
    "meterId":"a2nB20h1o0lc7k3P9xtWS8",
    "jobType":"ASSET",
    "callbackUrl":"https://MyExportJobStatus.com"
}

POST response

The following table describes the response fields:

Field	Type	Description
jobID	String	ID of the export job.
status	String	Status of the export job.
orgId	String	Organization ID for the requesting organization.
userId	String	ID of the user who sent the request.
selectedOrgId	String	Organization ID for the requesting organization.
meterId	String	Meter ID.
startDate	String	Start of the date range.
endDate	String	End of the date range.
callbackUrl	String	URL that the service uses to post the job status.
createTime	String	Time the export job was created.
updateTime	String	Time the export job was last updated.

POST response example

If successful, you might receive a response similar to the following example:

{
    "jobId": "cYjwJNEF7OckWEmkSC1tSI",
    "status": "CREATED",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "meterId": "a2nB20h1o0lc7k3P9xtWS8",
    "startDate": "2024-08-12T00:00:00Z",
    "endDate": "2024-09-12T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": "2024-09-12T23:19:21Z",
    "updateTime": "2024-09-12T23:19:21Z"
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Requesting asset-level data

Requesting asset-level data

POST request

POST request example

POST response

POST response example