Skip to main content
GET
/
api
/
partners
/
v2.0
/
org
/
{org_id}
/
users
/
{user_id}
/
heat-pumps
/
{heat_pump_id}
/
savings
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": {
    "requested_at": "<string>",
    "query": {},
    "units": {},
    "error": "<string>"
  },
  "data": [
    {
      "resolution": "<string>",
      "period": {
        "start_period": "<string>",
        "end_period": "<string>"
      },
      "savings": {
        "total": 123,
        "percentage": 123
      },
      "consumption": {
        "total": 123
      },
      "heat_pump": {
        "estimated_consumption_wh": 123
      },
      "electric_vehicle": {
        "estimated_consumption_wh": 123,
        "charge_session_count": 123,
        "average_charge_power_w": 123
      },
      "inverter": {
        "solar_production_wh": 123,
        "grid_export_wh": 123
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.podero.com/llms.txt

Use this file to discover all available pages before exploring further.

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

from
string<date-time>
required

Start of the date range

to
string
required

End of the date range

resolution
string
default:1MONTH

Time interval for aggregating data. Supported: 1DAY, 1WEEK, 1MONTH, 1QUARTER, 1YEAR

Response

200 - application/json

OK

metadata
StatisticsMetadata · object
required
data
StatisticsData · object[]
required