RelynkLearn
Builder APIAPI referenceConsumption

consumption.meters (version 1)

Consumption of up to 10000 EOS meters (energy, water, waste; ids from meters.list) per Oslo-time bucket over [from, to), from the hourly values EOS processed (resets, gaps and virtual meter formulas handled): consumption, the estimated part, cost, missing hours and confidence per bucket, and per meter a total with the peak hour, coverage, cost coverage and hours per confidence tier. Values are consumption per hour, not meter readings: sum them, never take differences. Unit per meter: kWh, L or kg. null means no data, not zero (waste meters: no pickup is 0). For a building's total use consumption.buildings instead of adding meters: sub-meters are part of their parent. from and to must be whole hours; hour buckets up to 62 days, others up to 400, meters × days up to 20000.

POST
/consumption.meters/v1

Authorization

bearer
headerAuthorizationBearer <JWT>

A signed-in Relynk user's access token: OAuth 2.0 authorization code with PKCE at https://auth.relynk.io/authorize and https://auth.relynk.io/oauth/token, with audience https://ai.relynk.io/builder. The caller sees exactly what that user may see.

Query Parameters

tenantId?string

The tenant to read. May be left out when the caller belongs to exactly one tenant; GET /me lists them.

Formatuuid

Request Body

application/json
  1. body
meterIds*array<>

Meter ids (from meters.list), at most 10000

Items1 <= items <= 10000
from*string

Start, inclusive: "YYYY-MM", "YYYY-MM-DD" (Oslo midnight) or ISO 8601 with offset, e.g. "2026-09-01T06:00:00+02:00"

to*string

End, exclusive: "YYYY-MM", "YYYY-MM-DD" (Oslo midnight) or ISO 8601 with offset, e.g. "2026-09-01T06:00:00+02:00"

bucket*string

Bucket size; weeks start on Monday

Value in"hour""day""week""month"

Response Body

The function output

application/json
  1. response
timeZone*string
bucket*string
Value in"hour""day""week""month"
from*string
to*string
t*array<string>

Bucket starts, Oslo time with offset; index i matches every array

meters*array<>
Example Request
curl -X POST 'https://ai.relynk.io/builder/v1/consumption.meters/v1' \  -H 'Content-Type: application/json' \  -d '{  "meterIds": [    "bc2b2a7d-edc3-42a7-bdac-7a0ea3c64322"  ],  "from": "string",  "to": "string",  "bucket": "hour"}'
Example Response
{  "timeZone": "Europe/Oslo",  "bucket": "hour",  "from": "string",  "to": "string",  "t": [    "string"  ],  "meters": [    {      "meterId": "string",      "name": "string",      "carrier": "electricity",      "unit": "kWh",      "isBuildingMeter": true,      "isVirtual": true,      "buildingId": "string",      "consumption": [        0      ],      "estimated": [        0      ],      "cost": [        0      ],      "missingHours": [        0      ],      "confidence": [        "HIGH"      ],      "total": {        "consumption": 0,        "measured": 0,        "estimated": 0,        "estimatedShare": 0,        "cost": 0,        "costCoverage": 0,        "peak": {          "value": 0,          "at": "string"        },        "expectedHours": 0,        "missingHours": 0,        "pendingHours": 0,        "highHours": 0,        "mediumHours": 0,        "lowHours": 0,        "coverage": 0,        "confidence": "HIGH"      }    }  ]}