Lists aggregated measurements of a system over a period of time.
System measurements are the result of incorporating measurements from
all appliances that are part of a system. This allows computing e.g.
overall consumption adding producers (e.g. PV) and subtracting consumers
(e.g. EV charging stations). This aggregation is performed in various
resolutions to suit different use cases. See the 'resolution' parameter
for a list of options.
Depending on the resolution parameter, the response contains either
power or energy measurements (unless otherwise documented):
- power (unit: W):
15m
,1h
- energy (unit: Wh):
1d
,1w
,1M
,1y
Measurements are "aligned" differently whether they contain energy or
power measurements:
- For power values the data point is written after the aggregated time
span. For the interval 2018-04-01T00:00:00Z/2018-04-02T00:00:00Z
with resolution 15m the first observation will be recorded at
2018-04-01T00:15:00Z - For energy values the observation is stored at the beginning of
the aggregated time span. For the interval
2018-04-01T00:00:00Z/2018-04-05T00:00:00Z and resolution 1d the first
observation will be recorded at 2018-04-01T00:00:00Z
The total
object of the response contains an aggregation of the
individual data points over time and therefore is an energy value.
The total.measuredAt
field is an interval containing all data points
in the requested interval.
In order to reduce the duration of the endpoint, the gridX API imposes
limitations on the interval for a given resolution:
Resolution | Limit |
---|---|
15m | intervals up to 1 day |
1h | intervals up to 1 week |
1d | intervals up to 1 month |
1w | intervals up to 1 month |
1M | intervals up to 5 years |
1y | no limit |