Query Total Energy Consumption of Devices

Last Updated on : 2023-06-15 05:53:28

Query the total energy consumption data of multiple devices within a specified time range, including the usage, generation, or dump analysis statistics regarding water, electricity, and natural gas.

API address

GET: /v1.0/iot-03/energy/{energy_type}/device/nodes/statistics-sum

Request parameter

Parameter name	Type	IN	Required	Description
energy_type	String	uri	true	The energy type. Set the value to `electricity`.
energy_action	String	query	true	The energy behavior. Set the value to `consume`, representing energy consumption.
statistics_type	String	query	true	The statistical type. Valid values: `month`: by month, in the format of `yyyyMM`. The maximum span is 12 months, and you can only query the data of the last 12 months. `day`: by day, in the format of `yyyyMMdd`. The maximum span is 7 days, and you can only query the data of the last 90 days. `hour`: by hour, in the format of `yyyyMMddHH`. The maximum span is 24 hours, and you can only query the data of the last 7 days.
start_time	String	query	true	The start time.
end_time	String	query	true	The end time.
contain_childs	Boolean	query	true	Indicates whether to contain the data of the child nodes. Default value: `true`.
device_ids	String	query	true	The list of device IDs to be included in the statistics.

Return parameter

Parameter name	Type	Description
result	Float	The statistical result. Unit: kWh.

Request example

GET: /v1.0/iot-03/energy/electricity/device/nodes/statistics-sum?energy_action=consume&statisticsType=day&startTime=20210925&endTime=20210926&containChilds=false&device_ids=147355207358382****,147355203680817****

Return example

{
    "result": 40,
    "t": 1641439262706,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Total Energy Consumption of Node

Next DocSummarize Energy Consumption Trend of Devices