Query Energy Consumption Ranking in Space

Last Updated on : 2023-06-21 07:13:05download

Query energy consumption ranking of devices in a space within a specified time range, including the usage, generation, or dump statistics regarding water, electricity, and natural gas.

API address

GET: /v1.0/iot-03/energy/{energy_type}/space/statistics/devices-top

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.
limit Integer query false The limited number of statistics. Default value: 10. Maximum value: 100.
contain_childs Boolean query false Indicates whether to contain the data of the child nodes. Default value: true.

Return parameter

Parameter name Type Description
result List

Description of result

Parameter name Type Description
device_id String The device ID.
value Float The energy data.

Request example

GET: /v1.0/iot-03/energy/electricity/space/statistics/devices-top?energy_action=consume&statisticsType=day&startTime=20210923&endTime=20210923&containChilds=false

Return example

{ "result": [ { "device_id": "xxx", "value": 49 } ], "t": 1632454872072, "success": true }

Error code

For more information, see error code.