English
English
简体中文
Contact Us
Register
Log In

Get Effective Interaction Data

Last Updated on : 2022-09-21 07:11:36

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 nameTypeINRequiredDescription
paramsStringquerytrueJSON

Description of params

Parameter nameTypeINRequiredDescription
startDayString trueThe start time.
endDayString trueThe end time.
productIdString falseThe product ID.
countryString falseThe country or region.
dimensionString falseThe 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 nameTypeDescription
resultJSONArrayThe returned result.

Description of result

Parameter nameTypeDescription
interactionNumIntegerThe number of effective interactions of the devices.
enCountryNameStringThe country or region name in English.
dtStringThe date.
formatCountryNameStringThe 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.