Site Level Consumption Monitoring

Retrieves telemetry for all consumption meters for a system

Retrieves telemetry for all the consumption meters of a system. If you request a start date earlier than when the system first reported data, we use midnight of the first reported date instead. The first reported date is the later of the system’s First Interval End Date or Interconnection Date. The end_at is calculated as the minimum of the time of the request and (start time + granularity). The meaning of granularity is as follow: If granularity is 15mins, maximum 1 interval will appear in response. If granularity is day, maximum 96 intervals, and if granularity is week, maximum 672 intervals, will appear in response where each interval is of 15 mins duration.

The requested start date must be within 2 years from current date. By default start_at will appear in response. If start_date parameter is passed in the url, then start_date field will appear in response. By default end_at will appear in response. If end_date parameter is passed in the url then end_date field will appear in response. Empty list will be returned if the last interval < requested start time < current time.

get/api/v4/systems/{system_id}/telemetry/consumption_meter

Request

Path parameters

system_idinteger required

The unique numeric ID of the system

Query parameters

start_atinteger

Requested start time for telemetry data in Epoch time format. Alternatively one can use start_date in place of start_at for passing the start date as String in YYYY-MM-DD format. If no start_at is specified, defaults to midnight today, in the timezone of the system. If you request a start date earlier than when the system first reported data, we use midnight of the first reported date instead. The first reported date is the later of the system’s First Interval End Date or Interconnection Date. By default start_at will appear in response. If start_date parameter is passed in the url, then start_date field will appear in response.

granularity'5mins' | '15mins' | 'day' | 'week'

The granularity of the telemetry data. Possible values are 'week', 'day', '15mins', '5mins'. Default is 'day'

Response

Telemetry for all consumption meters

system_idinteger

The unique numeric ID of the system

granularitystring

The granularity of the telemetry data. Possible values are 'week', 'day', '15mins', '5mins'. Default is 'day'

total_devicesinteger

Number of non-retired consumption meters in the site

start_atinteger

Start Time of the data series. Either Start_date or start_at will be present. By default start_at will appear in response. If start_date parameter is passed in the url, then start_date field will appear in response.

end_atinteger

End Time of the data series. Either end_date or end_at will be present. By default end_at will appear in response. If end_date parameter is passed in the url, then end_date field will appear in response.

itemsstring

The list key 'intervals'

Changes

No recorded changes to this operation across all 1 revision of this API.