Query Heatmap Analytics Config

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

Query the configurations of heatmap analytics devices under a specified asset.

API address

GET: /v1.0/iot-03/hotspots/{asset_id}/settings

Request parameter

Parameter name	Type	IN	Required	Description
asset_id	String	uri	true	The asset number.
start_date	String	query	false	The 13-bit timestamp of the start date. If no value is entered, query the latest effective data.
is_invalid	String	query	false	Specifies whether to include data newly added that day but not yet effective. Valid values: `true`: yes. `false`: no. Default value.

Return parameter

Parameter name	Type	Description
result	ShopHotspotsSettingRes	The returned result.

Description of result

Parameter name	Type	Description
asset_id	String	The asset number.
asset_name	String	The asset name.
image_url	String	The URL of a specified space image.
image_width	Integer	The width of a specified image.
image_height	Integer	The height of a specified image.
grid_step	Integer	The grid step.

Request example

GET: /v1.0/iot-03/hotspots/1402089311297372***/settings

Return example

{
    "result": {
        "image_url": "1234",
        "grid_size": 90,
        "image_width": 800,
        "shop_id": "1402089311297372****",
        "image_height": 900,
        "grid_row": 10,
        "grid_col": 10
    },
    "t": 1625470687748,
    "success": true
}

Error code

For more information, see error code.