Combined Appliance and Category Disaggregation
Users with high resolution data receive two main types of energy insights: the energy disaggregation into categories and the appliance events. Their main expectation is to see the energy distributed among categories and each category further distributed among the underlying appliances.
The currently available CE-API endpoints are not tailored to provide an accurate combination of these two insights. To address this, two new endpoints are being implemented, providing breakdowns at the weekly and monthly levels.
High Resolution users
For end-users with high-resolution data, the GET disaggregation-category-breakdown endpoint provides a unified view of category and appliance-level disaggregation for a specific week or month.
Request for Weekly Breakdown
GET /v2/disaggregation-category-breakdown/weekly/{year}/{week}
Authorization: Bearer <access_token>
Response
{
"status": "ok",
"timestamp": "2022-02-17T11:07:08+01:00",
"data": {
"electricity": {
"total_energy": 488.775,
"total_cost": 19.76,
"disaggregation_categories": {
"alwaysOn": {
"energy_usage": 88.015,
"cost": 1.52
},
"refrigeration": {
"energy_usage": 31.076,
"cost": 1.52
},
"cooking": {
"energy_usage": 1.206,
"cost": 1.52,
"appliances": {
"oven": {
"appliance_energy_usage": 1.1,
"cost": 1.32
},
"other": {
"appliance_energy_usage": 0.106,
"cost": 0.2
}
}
},
"lighting": {
"energy_usage": 9.215,
"cost": 1.52
},
"entertainment": {
"energy_usage": 18.619,
"cost": 1.52
},
"laundry": {
"energy_usage": 56.72,
"cost": 4.56,
"appliances": {
"dishWasher": {
"appliance_energy_usage": 27.186,
"cost": 1.52
},
"washingMachine": {
"appliance_energy_usage": 8.16,
"cost": 1.52
},
"dryer": {
"appliance_energy_usage": 20.1,
"cost": 1.5
},
"other": {
"appliance_energy_usage": 2.274,
"cost": 0.02
}
}
},
"spaceHeating": {
"energy_usage": 18.2227,
"cost": 4.56,
"appliances": {
"airConditioning": {
"appliance_energy_usage": 9.186,
"cost": 1.52
},
"heatPumps": {
"appliance_energy_usage": 8.16,
"cost": 1.52
},
"other": {
"appliance_energy_usage": 0.8767,
"cost": 1.52
}
}
},
"waterHeating": {
"energy_usage": 0,
"cost": 0
},
"electricVehicle": {
"energy_usage": 201.033,
"cost": 1.52
},
"poolOrSauna": {
"energy_usage": 0,
"cost": 0
},
"other": {
"energy_usage": 54.6683,
"cost": 1.52
}
}
},
"production": {
"total_energy": 297.665,
"total_cost": 44.6497,
"dissagregation_categories": {
"solar": {
"energy_usage": 297.665,
"cost": 44.6497
}
}
},
"gas": {
"total_energy": 14.582,
"total_cost": 29.164,
"dissagregation_categories": {
"spaceHeating": {
"energy_usage": 4.2288,
"cost": 8.4576
},
"waterHeating": {
"energy_usage": 4.1121,
"cost": 4.2242
},
"cooking": {
"energy_usage": 6.241,
"cost": 12.482
}
}
}
}
}
Request for Monthly Breakdown
GET /v2/disaggregation-category-breakdown/monthly/{year}/{month}
Authorization: Bearer <access_token>
The response will have the same structure as the weekly one.
Low Resolution users
For end-users with low-resolution data, where no appliance events are available, this endpoint provides a disaggregation categories breakdown for the requested week or month, without data at the appliance level.
The request is the same as for High Resolution users, only the response contains less information:
Request
GET /v2/disaggregation-category-breakdown/weekly/{year}/{week}
Authorization: Bearer <access_token>
Response
{
"status": "ok",
"timestamp": "2022-02-17T11:07:08+01:00",
"data": {
"electricity": {
"total_energy": 488.775,
"total_cost": 19.76,
"disaggregation_categories": {
"alwaysOn": {
"energy_usage": 88.015,
"cost": 1.52
},
"refrigeration": {
"energy_usage": 31.076,
"cost": 1.52
},
"cooking": {
"energy_usage": 1.206,
"cost": 1.52,
},
"lighting": {
"energy_usage": 9.215,
"cost": 1.52
},
"entertainment": {
"energy_usage": 18.619,
"cost": 1.52
},
"laundry": {
"energy_usage": 56.72,
"cost": 4.56,
},
"spaceHeating": {
"energy_usage": 18.2227,
"cost": 4.56,
},
"waterHeating": {
"energy_usage": 0,
"cost": 0
},
"electricVehicle": {
"energy_usage": 201.033,
"cost": 1.52
},
"poolOrSauna": {
"energy_usage": 0,
"cost": 0
},
"other": {
"energy_usage": 54.6683,
"cost": 1.52
}
}
},
"production": {
"total_energy": 297.665,
"total_cost": 44.6497,
"dissagregation_categories": {
"solar": {
"energy_usage": 297.665,
"cost": 44.6497
}
}
},
"gas": {
"total_energy": 14.582,
"total_cost": 29.164,
"dissagregation_categories": {
"spaceHeating": {
"energy_usage": 4.2288,
"cost": 8.4576
},
"waterHeating": {
"energy_usage": 4.1121,
"cost": 4.2242
},
"cooking": {
"energy_usage": 6.241,
"cost": 12.482
}
}
}
}
}
Using the aforementioned endpoints, customers will find it much easier to provide a clear energy insight section in their app combining appliances and categories in a seamless way.
Updated 2 months ago