Get measurements for service

get https://{kitEnvironment}.{kitDomain}/{kitBasePath}/accounts/{accountId}/measurements/{measurementId}

Gets the measurements for the service specified by the measurementId parameter, for the given time period and resolution.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

startDate

date-time

required

length ≥ 19

The date-time start date for the measurement.
If the service.startDate is later than the request fromDate this should be service.startDate

endDate

date-time

required

length ≥ 19

The date-time end date for the measurement, noninclusive.
For the current month the endDate should be the latest day with measurements.

resolution

string

required

length ≥ 1

The resolution for the data.

year month day hour 15min

comparisonProperties

array of objects

length ≥ 0

This is used to be able to present values together with the measurement.
At the moment we only support degreeDay (sv: graddagskorrigeringar av fjärrvärme).

comparisonProperties

object

key

string

length ≥ 1

The key for the value in the values array.

degreeDay

unit

string

length ≥ 1

The unit for comparison.

values

array of objects

required

length ≥ 0

values*

object

date

date-time

required

length ≥ 19

The date-time associated with the measurement value.

This should be startOf month for the period if the resolution is month. Even if the measurement is only a part of the month.

kWh

Energy consumption or production.

Volumetric consumption.

For services where mass is a relevant measurement.

peakWatt

object

For cost calculations based on peak watt as load tariffs.

cost

float

The cost relating to this measurement value.
When this value is set, no cost calculations will be performed for this MeasurementValue.

parts

array of objects

length ≥ 0

If the cost can be specified for different cost items.

parts

object

name

string

required

length ≥ 1

value

float

required

cost

float

≥ 0

compare

array of objects

length ≥ 0

For values that should be possible to visualise together with the measurement.

compare

object

key

string

length ≥ 1

The type to compare against.

degreeDay

value

float

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://staging.domain/v1/accounts/accountId/measurements/measurementId?resolution=year' \
3
     --header 'accept: application/json'


xxxxxxxxxx
44
}
1
{
2
  "startDate": "2019-08-24T14:15:22Z",
3
  "endDate": "2019-08-24T14:15:22Z",
4
  "resolution": "month",
5
  "comparisonProperties": [
6
    {
7
      "key": "degreeDay",
8
      "unit": "string"
9
    }
10
  ],
11
  "values": [
12
    {
13
      "date": "2019-08-24T14:15:22Z",
14
      "kWh": 0,
15
      "m3": 0,
16
      "kg": 0,
17
      "cost": 0,
18
      "peakWatt": {
19
        "value": 13.32,
20
        "cost": 459,
21
        "peaks": [
22
          {
23
            "date": "2020-01-13T06:37:00Z",
24
            "value": 13.32,
25
            "partKey": "reactiveLow"
26
          }
27
        ]
28
      },
29
      "parts": [

200OK

400Bad Request

401Forbidden

404Resource Not Found