HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Download Meter Intervals by Site

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 site IDs is 500. If you need to download more than 500 sites, you will need to make multiple requests, or alternatively provide search/globalSearch (the same filters as List Sites) to download intervals for every site matching the search. 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

The method used to download the data.

Allowed:
date-time
required

The end date of the billing period.

string

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

ids
array of strings

An array of unique identifiers for multiple meters/sites.

ids
string
enum

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

Allowed:
string
enum

The timezone for the intervals. Default : METER

Allowed:
string

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

date-time
required

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

Headers
string
required
Defaults to 2024-02-21

The Arcadia-Version for the request

string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/json