Query Linked Foot Traffic Statistics Devices

Last Updated on : 2023-06-15 05:51:59

Query the configuration information of the linked foot traffic statistics devices under the specified asset. Currently, you can only query the configuration of the region of interest.

API address

GET: /v1.0/iot-03/passenger-flows/assets/assigned-devices/{device_id}/configs

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Return parameter

Parameter name	Type	Description
result	AssignDeviceConfig	The returned result.

Description of result

Parameter name	Type	Description
image_width	Integer	The image width in pixels.
image_height	Integer	The image height in pixels.
areas	List	The region of interest.

Description of areas

Parameter name	Type	Description
type	Integer	The type of the region of interest. Valid values: `1`: region of entering the store. `2`: region of passing by the store.
points	List	The information about a specific point.Establish a coordinate system by using the top left corner of the image as the zero point, the width as the x-axis, and the height as the y-axis. Unit: in pixels.
in	String	The direction of entering the store. Valid values: `top`: up `down`: down `left`: left `right`: right
out	String	The direction of leaving the store. Valid values: `top`: up `down`: down `left`: left `right`: right

Description of points

Parameter name	Type	Description
x	Integer	The point of the latitudinal coordinate.
y	Integer	The point of the longitudinal coordinate.

Request example

GET: /v1.0/iot-03/passenger-flows/assets/assigned-devices/111****/configs

Return example

{
    "result": {
        "areas": [
            {
                "type": 1,
                "points": [
                    {
                        "x": 0,
                        "y": 0
                    },
                    {
                        "x": 1920,
                        "y": 0
                    },
                    {
                        "x": 1920,
                        "y": 1080
                    },
                    {
                        "x": 0,
                        "y": 1080
                    }
                ]
            },
            {
                "type": 2,
                "points": [
                    {
                        "x": 0,
                        "y": 0
                    },
                    {
                        "x": 1920,
                        "y": 0
                    },
                    {
                        "x": 1920,
                        "y": 1080
                    },
                    {
                        "x": 0,
                        "y": 1080
                    }
                ]
            }
        ],
        "image_width": 1920,
        "image_height": 1080
    },
    "t": 1111111111111,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery History of Foot Traffic Data

Next DocUnlink Foot Traffic Statistics Device