Get All Usage Hours with DeviceId (Energy devices)
path Parameters
deviceIdGet All Usage Hours with DeviceId (Energy devices) › Responses
Return all usage hours for energy devices (PLUG/MCB).
_idPrimary ID of the UsageHistoryHour
hourNo. What Hour (E.g. 7 means 0700 - 0800)
onStatusStatus of the Plug (ON / OFF)
deviceTypeType of device (PLUG, MCB, etc.)
createdAtDate Time of the Creation
updatedAtDate Time of the Update
actualDateDate Time of the Update
macIdMAC ID of the device
deviceReference to the device
wifiStrengthWiFi signal strength at the time of the hourly record
Get Usage Hours for a Specific Date and Device
path Parameters
deviceIdquery Parameters
fromtillGet Usage Hours for a Specific Date and Device › Responses
Returns usage hours for a specific device and date.
_idPrimary ID of the UsageHistoryHour
hourNo. What Hour (E.g. 7 means 0700 - 0800)
onStatusStatus of the Plug (ON / OFF)
deviceTypeType of device (PLUG, MCB, etc.)
createdAtDate Time of the Creation
updatedAtDate Time of the Update
actualDateDate Time of the Update
macIdMAC ID of the device
deviceReference to the device
wifiStrengthWiFi signal strength at the time of the hourly record
Get Usage Days for a Specific Device (Energy devices)
path Parameters
deviceIdGet Usage Days for a Specific Device (Energy devices) › Responses
Returns usage days for energy devices (PLUG/MCB).
_idPrimary ID of the UsageHistoryDay
Usage History of the device (Hourly)
createdAtDate Time of the Creation
updatedAtDate Time of the Update
deviceTypeType of device (PLUG, MCB, etc.)
macIdMAC ID of the device
deviceReference to the device
Get Energy Usage for a distribution box within a date range
path Parameters
distributionBoxIdquery Parameters
fromtillGet Energy Usage for a distribution box within a date range › Responses
Returns a list of daily energy usage with cost for a distribution box.
dateNo. Hour of the Usage History
totalEnergyUsageTotal Energy Usage in a Day (kWh)
costEnergy cost for this day in dollars. Zero (0) if no tariff rate is configured for this day.
tariffRateTariff rate applied for this day in cents per kWh/L. Null if no tariff rate is configured.
Get daily energy usage for a device within a date range
path Parameters
deviceIdquery Parameters
fromtillGet daily energy usage for a device within a date range › Responses
Daily usage breakdown with cost for the device.
dateNo. Hour of the Usage History
totalEnergyUsageTotal Energy Usage in a Day (kWh)
costEnergy cost for this day in dollars. Zero (0) if no tariff rate is configured for this day.
tariffRateTariff rate applied for this day in cents per kWh/L. Null if no tariff rate is configured.
Get hourly usage for a device (Plug/MCB) within a date range with current tariff rate
Returns hourly usage breakdown and the current tariff rate for cost calculations.
path Parameters
deviceIdquery Parameters
fromtillGet hourly usage for a device (Plug/MCB) within a date range with current tariff rate › Responses
Returns hourly usage data and current tariff rate for a device.
Array of hourly usage data
currentTariffRateCurrent tariff rate in cost per kWh. Null if no tariff rate is configured. Useful for frontend calculations.
Get Energy Usage for energy devices (RealTime) using a Specific Date Range (MCB, Plug only)
Returns real-time energy usage data including power, current, voltage, and power factor for PLUG and MCB devices.
path Parameters
deviceIdquery Parameters
fromtillGet Energy Usage for energy devices (RealTime) using a Specific Date Range (MCB, Plug only) › Responses
Real-time energy usage data for MCB or Plug devices within date range
onStatusStatus of the device (ON / OFF)
createdAtDate Time of the Creation
currentCurrent in Amperes (A)
voltageVoltage in Volts (V)
powerFactorPower factor (0-1)
powerPower in Watts (W)
AI insight on what devices are in a room based on MCB data
Analyses 7 days of hourly MCB circuit data and 48 hours of realtime spikes to predict what electrical devices are likely present in the room.
path Parameters
roomIdAI insight on what devices are in a room based on MCB data › Responses
AI-generated device prediction for the room.
summaryOne-liner summary of room energy behaviour
List of predicted devices and why
Get Idle Energy Usage for a device (RealTime) using a Specific Date Range
path Parameters
deviceIdquery Parameters
fromtillGet Idle Energy Usage for a device (RealTime) using a Specific Date Range › Responses
Returns idle energy (RT) for a device.
energyTotal energy consumed by the device in watt-hours.
Get Average Energy Usage for a device (RealTime) using a Specific Date Range
path Parameters
deviceIdquery Parameters
fromtillGet Average Energy Usage for a device (RealTime) using a Specific Date Range › Responses
Returns average energy (RT) for a device.
energyTotal energy consumed by the device in watt-hours.
Get hourly usage for a distribution box within a date range with current tariff rate
Returns hourly usage breakdown and the current tariff rate for cost calculations.
path Parameters
distributionBoxIdquery Parameters
fromtillGet hourly usage for a distribution box within a date range with current tariff rate › Responses
Returns hourly usage data and current tariff rate for a distribution box.
Array of hourly usage data
currentTariffRateCurrent tariff rate in cost per kWh. Null if no tariff rate is configured. Useful for frontend calculations.
Get Usage and Energy Cost for a device (Plug/MCB/Distribution Box) from beginning to date
Returns total energy usage and calculated cost based on current tariff rate for any device type. Cost will be null if no tariff rate is configured for the system. This endpoint works for Plugs, MCBs, and Distribution Boxes.
path Parameters
deviceIdGet Usage and Energy Cost for a device (Plug/MCB/Distribution Box) from beginning to date › Responses
Returns usage, cost, and tariff rate for a device. Cost is calculated as totalEnergyUsage * tariffRate.
totalEnergyUsageTotal energy usage in kWh
totalCostTotal cost based on current tariff rate. Null if no tariff rate is configured.
tariffRateCurrent tariff rate in cost per kWh. Null if no tariff rate is configured.
Get hourly records for a Smart Switch device within a date range
Returns hourly downtime records for SMART_SWITCH devices, including gang switch states reported by the device.
path Parameters
deviceIdquery Parameters
fromtillGet hourly records for a Smart Switch device within a date range › Responses
Hourly Smart Switch records (downTime, onStatus, gangSwitchStatus)
hourHour of the day (0–23)
onStatusDevice on/off status for this hour
createdAtRecord creation timestamp
downTimeTotal downtime in milliseconds for this hour (3600000 = full hour down)
gangSwitchStatusGang switch states reported by the device (array index = gang index, 1 = ON, 0 = OFF)
actualDateActual date this hourly record is for
Get real-time readings for an Aircon Control device within a date range
Returns real-time ambient temperature and humidity readings (limited to 1000 records) for AIRCON_CONTROL devices that support sensor readings.
path Parameters
deviceIdquery Parameters
fromtillGet real-time readings for an Aircon Control device within a date range › Responses
Real-time aircon control readings (ambientTemperature, ambientHumidity)
onStatusDevice on/off status
createdAtRecord creation timestamp
ambientTemperatureAmbient temperature in Celsius
ambientHumidityAmbient humidity percentage
Get hourly records for an Aircon Control device within a date range
Returns hourly downtime records for AIRCON_CONTROL devices.
path Parameters
deviceIdquery Parameters
fromtillGet hourly records for an Aircon Control device within a date range › Responses
Hourly Aircon Control records (downTime, onStatus)
hourHour of the day (0–23)
onStatusDevice on/off status for this hour
createdAtRecord creation timestamp
downTimeTotal downtime in milliseconds for this hour (3600000 = full hour down)
ambientTemperatureAmbient temperature in Celsius
ambientHumidityAmbient humidity percentage
actualDateActual date this hourly record is for
Get hourly box plot aggregation for environment sensors on a given date
Aggregates real-time readings across multiple sensors, grouped by hour. Returns box plot statistics (min, Q1, median, Q3, max) using linear interpolation, plus available metrics based on sensor types.
query Parameters
sensorIdsComma-separated environment sensor device IDs
dateDate in YYYY-MM-DD format
metricMetric field to aggregate
Get hourly box plot aggregation for environment sensors on a given date › Responses
Hourly box plot entries with available metrics for the requested sensors
Hourly box plot entries (only hours with data)
availableMetricsAvailable metrics based on the sensor types of the requested sensors
Get drilldown data for a specific hour with per-sensor breakdown
Returns overall box plot statistics and per-sensor mean values for a specific date and hour. Useful for inspecting which sensors contributed to a particular hourly box plot.
query Parameters
sensorIdsComma-separated environment sensor device IDs
dateDate in YYYY-MM-DD format
hourHour of the day (0-23)
metricMetric field to aggregate
Get drilldown data for a specific hour with per-sensor breakdown › Responses
Overall box stats, per-sensor breakdown, total readings and sensor count
Overall box plot statistics across all readings
Per-sensor breakdown with mean values
totalSensorsTotal number of sensors with data
Get hourly environment readings for a sensor within a date range - New Architecture
Uses EnvironmentSensorUsageHistoryService. Returns hourly readings for all environmental metrics for ENV_SENSOR devices.
path Parameters
deviceIdquery Parameters
fromtillGet hourly environment readings for a sensor within a date range - New Architecture › Responses
Hourly environment readings (temperature, humidity, CO2, PM2.5, TVOC, sound, motion, etc.)
_idPrimary ID of the UsageHistoryHour
hourNo. What Hour (E.g. 7 means 0700 - 0800)
onStatusStatus of the Plug (ON / OFF)
deviceTypeType of device (PLUG, MCB, etc.)
createdAtDate Time of the Creation
updatedAtDate Time of the Update
actualDateDate Time of the Update
macIdMAC ID of the device
deviceReference to the device
carbonDioxideCurrent CO2 reading in ppm
formaldehydeCurrent formaldehyde (HCHO) reading in ppm
temperatureCurrent temperature reading in degrees Celsius
humidityCurrent humidity percentage
fineParticulateMatterCurrent Fine Particulate Matter in µg/m3
coarseParticulateMatterCurrent Coarse Particulate Matter in µg/m3
totalVolatileOrganicCompoundsTotal Volatile Organic Compounds in ppm
soundLevelCurrent Sound Level in dB
motionDetectedMotion detection status
wifiStrengthWiFi signal strength at the time of the hourly record
Get real-time environment readings for a sensor within a date range - New Architecture
Uses EnvironmentSensorUsageHistoryService. Returns real-time readings (limited to 1000 records) for ENV_SENSOR devices.
path Parameters
deviceIdquery Parameters
fromtillGet real-time environment readings for a sensor within a date range - New Architecture › Responses
Real-time environment readings (limited to 1000 most recent records within date range)
_idPrimary ID of the Usage History Real Time
onStatusStatus of the device (ON / OFF)
deviceTypeType of device (PLUG, MCB, etc.)
macIdMAC ID of the device
deviceReference to the device
createdAtDate Time of the Creation
temperatureCurrent temperature reading in degrees Celsius
carbonDioxideCurrent CO2 reading in ppm
formaldehydeCurrent formaldehyde (HCHO) reading in ppm
humidityCurrent humidity percentage
fineParticulateMatterCurrent Fine Particulate Matter in µg/m3
coarseParticulateMatterCurrent Coarse Particulate Matter in µg/m3
totalVolatileOrganicCompoundsTotal Volatile Organic Compounds in ppm
soundLevelCurrent Sound Level in dB
motionDetectedMotion detection status
Get hourly water meter readings for a device within a date range
Returns hourly water consumption readings including flow rate, pressure, and temperature for WATER_METER devices.
path Parameters
deviceIdquery Parameters
fromtillGet hourly water meter readings for a device within a date range › Responses
Hourly water meter readings (flow rate, pressure, temperature, consumption)
_idPrimary ID of the UsageHistoryHour
hourNo. What Hour (E.g. 7 means 0700 - 0800)
onStatusDevice status during this hour
deviceTypeType of device (PLUG, MCB, etc.)
createdAtDate Time of the Creation
updatedAtDate Time of the Update
actualDateDate Time of the Update
macIdMAC ID of the device
deviceReference to the device
waterConsumptionTotal water consumption for this hour (liters)
realTimeFlowRateAverage flow rate for this hour (L/min)
realTimePressureAverage pressure for this hour (bar)
wifiStrengthWiFi signal strength at the time of the hourly record
realTimeTemperatureAverage temperature for this hour (Celsius)
Get real-time water meter readings for a device within a date range
Returns real-time water consumption readings (limited to 1000 records) for WATER_METER devices.
path Parameters
deviceIdquery Parameters
fromtillGet real-time water meter readings for a device within a date range › Responses
Real-time water meter readings (limited to 1000 most recent records within date range)
_idPrimary ID of the Usage History Real Time
onStatusDevice status
deviceTypeType of device (PLUG, MCB, etc.)
macIdMAC ID of the device
deviceReference to the device
createdAtDate Time of the Creation
realTimeFlowRateCurrent flow rate in liters per minute (L/min)
realTimePressureWater pressure in bar
waterConsumptionCumulative water consumption in liters
realTimeTemperatureWater temperature in Celsius
Get daily water meter readings for a device within a date range
Returns daily water consumption aggregates including total consumption, average flow rate, pressure, and temperature for WATER_METER devices.
path Parameters
deviceIdquery Parameters
fromtillGet daily water meter readings for a device within a date range › Responses
Daily water meter readings (total consumption, avg flow rate, avg pressure, avg temperature)
_idPrimary ID of the UsageHistoryDay
Usage History of the device (Hourly)
createdAtDate Time of the Creation
updatedAtDate Time of the Update
deviceTypeType of device (PLUG, MCB, etc.)
macIdMAC ID of the device
deviceReference to the device
waterConsumptionTotal daily water consumption (liters)
realTimeFlowRateAverage daily flow rate (L/min)
realTimePressureAverage daily pressure (bar)
realTimeTemperatureAverage daily temperature (Celsius)