Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Intervals

List Normalized Intervals for a Meter

The Intervals API endpoint allow interacting programmatically with the intervals data offering of the Arcadia Platform to retrieve utility provided intervals data for electric meters. The normalized version of the interval endpoint makes integration simpler by consistently delivering interval data of 15 minute intervals irrespective of the length of timestamp in the source data collected from utility.

get/plug/normalizedIntervals/meters/{meterId}

Path parameters

meterIdstring required

Query parameters

startAtstring date-time

API response returns up to 1 year of interval data from the startAt datetime requested

endAtstring date-time

API response returns up to 1 year of interval data up to the endAt datetime requested

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

correlationIdsstring[] required

A list of correlationIds cascaded from all directly associated Credentials.

credentialIdsstring[] required

Arcadia generated unique identifier of the credential the meter belongs to.

earliestIntervalAtstring date-time required

Timestamp of the earliest interval available for the meter.

endAtstring date-time required

start time of last record in API response.

intervalDurationMinutesinteger required

Interval duration timestamp length in API response.

intervalsCreatedAtstring date-time required

Timestamp when intervals were first created for the meter.

intervalsUpdatedAtstring date-time required

Timestamp when intervals were last updated for the meter.

isIntervalsDormantboolean nullable required

Indicates whether the meter is dormant based on interval job results and error codes.

latestIntervalAtstring date-time required

Timestamp of the latest interval available for the meter.

localTimezonestring required

Local timezone of the meter. The value can be any TZ identifier from this list.

meterIdstring required

Arcadia generated unique identifier of the meter

meterNumberstring required

A number assigned to the meter by the commodity provider.

providerIdstring required

Arcadia generated unique identifier of the utility service provider.

providerNamestring required

The name of the utility service provider.

readTypestring nullable required

Type of reading (actual, estimated, etc.)

serviceTypestring required

The type of service supported, such as electricity, water, or gas.

sourceIntervalDurationMinutesinteger[] required

Interval duration timestamp length as collected from utility.

startAtstring date-time required

start time of first record in API response.

Example response

{
  "intervalDurationMinutes": 15,
  "sourceIntervalDurationMinutes": [
    60
  ]
}