Query Energy Consumption Ranking in Space

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

Query energy consumption ranking 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-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.
depth	Integer	query	false	The level of a specified space. Default value: `0`, indicating the first level in the space. The value range is `0` to `9`.
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
value	Float	The value of energy consumption.
space_id	String	The ID of a specified space.

Request example

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

Return example

{
    "result": [
        {
            "space_id": "xxx",
            "value": 1.1
        }
    ],
    "t": 1624525873263,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Energy Data Trend

Next DocQuery Energy Consumption Trend in Space