Cloud Services API ReferenceSmart HomeData Dashboard ServiceBasic DataGet Effective Interaction Data

Get Effective Interaction Data

Last Updated on : 2023-07-28 06:26:24download

Get the effective interaction data of the devices within the specified time range.

API address

GET: /v1.0/iot-datacenter/app/device/effective/interaction/stat

Request parameter

Parameter name	Type	IN	Required	Description
params	String	query	true	JSON

Description of params

Parameter name	Type	Required	Description
startDay	String	true	The start time.
endDay	String	true	The end time.
productId	String	false	The product ID.
country	String	false	The country or region.
dimension	String	false	The dimension. Optional fields are as follows. `format_country_name`: the country or region name in Chinese. `en_country_name`: the country or region name in English.

Return parameter

Parameter name	Type	Description
result	JSONArray	The returned result.

Description of result

Parameter name	Type	Description
interactionNum	Integer	The number of effective interactions of the devices.
enCountryName	String	The country or region name in English.
dt	String	The date.
formatCountryName	String	The country or region name in Chinese.

Request example

GET: /v1.0/iot-datacenter/app/device/effective/interaction/stat?params={"startDay":"20211007" ,"endDay":"20211007","dimension":"en_country_name"}

Return example

{
    "result": [
        {
            "dt": 20211007,
            "enCountryName": "United States",
            "interactionNum": 0
        },
        {
            "dt": 20211007,
            "enCountryName": "Others",
            "interactionNum": 459
        },
        {
            "dt": 20211007,
            "enCountryName": "Germany",
            "interactionNum": 10
        },
        {
            "dt": 20211007,
            "enCountryName": "Japan",
            "interactionNum": 0
        },
        {
            "dt": 20211007,
            "enCountryName": "China",
            "interactionNum": 1167
        }
    ],
    "t": 1633764761266,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Product Data Overview

Next DocGet Regional Distribution Details