Energy Consumption Ranking

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

Query energy statistics data of monitors 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}/monitors-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.
start_time String query true The start time.
end_time String query true The end time.
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.
limit Integer query false The top N monitors. Default value: 10.

Return parameter

Parameter name Type Description
result List

Description of result

Parameter name Type Description
monitor_id String The monitor ID.
value Float The energy data.

Request example

GET: /v1.0/iot-03/energy/electricity/monitors-top?energy_action=consume&energy_type=electricity&statistics_type=hour&start_time=2021092314&end_time=2021092318&limit=10

Return example

{ "result": [ { "monitor_id": "xxx", "value": 44.3 } ], "t": 1632465215381, "success": true }

Error code

For more information, see error code.