Skip to main content
GET
/
api
/
partners
/
v2.0
/
org
/
{org_id}
/
users
/
{user_id}
/
heat-pumps
/
{heat_pump_id}
/
savings
(Alpha) Get savings data for a specified heat pump
curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}/savings \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {},
  "data": [
    {
      "resolution": "<string>",
      "period": {},
      "cost": {},
      "co2": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
org_id
string<uuid>
required

The organization ID

​
user_id
string<uuid>
required

The user ID

​
heat_pump_id
string<uuid>
required

The heat pump ID

Query Parameters

​
resolution
string
default:1DAY

The time interval for aggregating data. Comman Seperated list. Supported values: 1DAY, 1WEEK, 1MONTH, 1QUARTER, 1YEAR

​
keywords
string

A comma-separated list of keywords. Supported values: cost

Response

200 - application/json

OK

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