Skip to main content
GET
/
api
/
partners
/
v2.0
/
org
/
{org_id}
/
users
/
{user_id}
/
heat-pumps
/
{heat_pump_id}
/
data
Get heat pump data
curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}/data \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {},
  "data": [
    {
      "time": "<string>",
      "price": 123,
      "inlet_temp_act": 123,
      "hot_water_temp": 123,
      "estimated_consumption": 123,
      "simulated_consumption": 123,
      "unoptimized_consumption": 123,
      "estimated_consumption_filtered": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
fill-missing
boolean
default:false

When set to true, the API will return the full requested time range, filling missing values with null. If no data is available at all, an empty dataset with null values will be returned instead of a 400 error.

Path Parameters

​
org_id
string<uuid>
required

The organization ID of the user's organization

​
user_id
string<uuid>
required

The user ID of the user whom the heat pump belongs to

​
heat_pump_id
string<uuid>
required

The ID of the specified heat pump

Query Parameters

​
from_datetime
string<date-time>

The start of the time range for the data

​
to_datetime
string<date-time>

The end of the time range for the data

​
resolution
string
default:15MIN

The time interval for aggregating data. Supported values: 15MIN, 1HOUR, 1DAY, 1WEEK, 1MONTH

​
keywords
string

A comma-separated list of keywords, Supported values: inlet_temp_act, hot_water_temp, estimated_consumption, unoptimized_consumption, price

​
include_deleted
boolean
default:false

If true, includes soft-deleted

Response

200 - application/json

OK

​
metadata
Metadata · object
required
​
data
HeatPumpDataPointOutput · object[]
required