v1

latestOpenAPI 3.0.12026-07-248498266.5 KB

Meters

Download Meter Intervals

Downloading a CSV file with meter intervals is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. The next step is to download the file using a GET request with the response body URL. The maximum number of meter IDs is 500. If you need to download more than 500 meters, you will need to make multiple requests. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint.

This endpoint supports Sandbox Mode.

post/plug/meters/downloads/intervals

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

downloadMethod'EMAIL' | 'IN_BROWSER'

The method used to download the data.

endAtstring date-time required

The end date of the billing period.

globalSearchstring

Global search across meter fields, used together with select-all by search.

idsstring[]

An array of unique identifiers for multiple meters/sites.

intervalFormat'RAW' | 'NORMALIZED'

The format in which output data is provided. Default : RAW

intervalTimeZone'UTC' | 'METER'

The timezone for the intervals. Default : METER

searchstring

RSQL filter selecting the meters to download intervals for (select-all by search). An empty value means no filter (all meters).

startAtstring date-time required

The date indicating the start of a billing cycle or service period.

Response

Accepted

createdAtstring date-time required

A timestamp indicating when the entity was created.

downloadMethod'EMAIL' | 'IN_BROWSER' required

Method used for downloading data.

idstring required

A unique identifier for the entity.

status'SUCCESS' | 'PREPARING' | 'FAILURE' | 'NO_CONTENT' required

Status of the resource.

tokenstring required

We require this token to be provided when you want to access the requested download file. If you made the request via an API call, this token can be found in our response to you. If you made the request via the Dashboard, this token already be included in the email we would send you.