RelynkLearn
Builder APIAPI referencePoints

points.summary (version 1)

One summary per point over [from, to) (up to 380 days): count, min and max with their times, average, sum, and first and last reading with their times. Cheaper than points.timeseries when one number per point is enough, e.g. the warmest room last month.

POST
/points.summary/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
pointIds*array<>

Point ids (from points.list), at most 500

Items1 <= items <= 500
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"

Response Body

The function output

application/json
  1. response
timeZone*string
from*string

Resolved start, Oslo time with offset

to*string

Resolved end (exclusive), Oslo time with offset

points*array<>
Example Request
curl -X POST 'https://ai.relynk.io/builder/v1/points.summary/v1' \  -H 'Content-Type: application/json' \  -d '{  "pointIds": [    "077ab0e7-997d-450a-aa83-a0ee4c7f1644"  ],  "from": "string",  "to": "string"}'
Example Response
{  "timeZone": "Europe/Oslo",  "from": "string",  "to": "string",  "points": [    {      "pointId": "string",      "unitKey": "string",      "count": 0,      "min": 0,      "minAt": "string",      "max": 0,      "maxAt": "string",      "avg": 0,      "sum": 0,      "first": 0,      "firstAt": "string",      "last": 0,      "lastAt": "string"    }  ]}