Query Overview of Monitored Object

Last Updated on : 2023-06-15 06:02:49

Query an overview of monitoring metrics of a specified monitored object on pages.

API address

GET: /v1.0/iot-03/si/monitor-data/survey/page

Request parameter

Parameter name	Type	IN	Required	Description
attr_code	String	query	true	The code of a specified attribute.
monitor_type	String	query	true	The type of a specified metric. `energy_collect`: industrial energy consumption metric. `environment`: industrial environment metric. `vibration`: industrial vibration metric.
monitor_object_type	String	query	true	The type of a specified monitored object. `energy_collect`: industrial energy consumption object. `environment`: industrial environment object. `vibration`: industrial vibration object.
page_no	Integer	query	false	The current page number. Default value: `1`, which means the first page.
page_size	Integer	query	false	The number of items returned on each page. Default value: `20`. Maximum value: `100`.

Return parameter

Parameter name	Type	Description
result	Page	The returned result.

Description of result

Parameter name	Type	Description
total	Long	The total number of items.
list	List	The list of data.
has_more	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
value	String	The value of a specified attribute.
monitor_object_id	String	The ID of a specified monitored object.
monitor_object_name	String	The name of a specified monitored object.
tuya_device_id	String	The device ID.

Request example

GET: /v1.0/iot-03/si/monitor-data/survey/page?attr_code=co2_value&page_no=1&page_size=9&monitor_type=environment&monitor_object_type=environment

Return example

{
    "result": {
        "list": [
            {
                "tuya_device_id": "vdevo16376349197****",
                "monitor_object_id": "146334359530244****",
                "monitor_object_name": "West Lake",
                "value": "56.36"
            },
            {
                "tuya_device_id": "vdevo1637687510****",
                "monitor_object_id": "1463343897225****",
                "monitor_object_name": "West Lake",
                "value": "54.28"
            }
        ],
        "total": 2
    },
    "t": 1632726643155,
    "success": true
}

Error code

For more information, see error code.

Prev DocEnvironmental monitoring data

Next DocQuery Historical Data