Skip to main content
GET
Get an Organisation's Devices Savings

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 of the user's organization

Query Parameters

start_datetime
string<date-time>
required

Start datetime for savings calculation

end_datetime
string<date-time>
required

End datetime for savings calculation

resolution
string

Bucket the org total into a time series (1DAY/1WEEK/1MONTH/1QUARTER/1YEAR). Mutually exclusive with by.

by
string

Range-total breakdown: device, device_type, or oem (manufacturer). Mutually exclusive with resolution.

limit
integer
default:50

Max rows for by=device (the top savers by range total). Ignored by other modes.

Required range: 1 <= x <= 1000
order
string
default:desc

Sort direction for by=device by savings: desc (best savers) or asc (worst performers). Ignored by other modes.

Response

200 - application/json

OK

total_savings
number
required
heat_pump_savings
number
required
electric_vehicle_savings
number
required
inverter_savings
number
required