云服务 API 参考全屋智能数据星象仪API基础数据获取激活设备地区分布详情数据(不包含城市明细)

获取激活设备地区分布详情数据(不包含城市明细)

更新时间:2023-07-28 06:26:36下载pdf

本文介绍获取激活设备地区分布详情数据(不包含城市明细)的 API。

接口描述

根据时间格式、产品和地区类型获取激活设备地区分布详情数据,数据中的地区和国家下不包含城市明细。

接口地址

GET: /v1.1/devices/locations-active-datas

请求参数

参数名类型参数位置是否必填说明
date_typeStringquerytrue时间格式:
  • day:天
  • week:周
  • weeks:两周
  • month:月
product_idStringqueryfalse产品ID,不填写则获取用户所有产品
typeStringquerytrue地区范围:
  • country:地区
  • province:省
  • city:市
limitIntegerquerytrue限制数,取值范围为 0~100。

返回参数

参数名类型说明
resultJSONArray返回结果

result 说明

参数名类型说明
percentageString地区激活数/总激活数
nameString地区名
valueInteger地区总激活的设备数

请求示例

GET: /v1.1/devices/locations-active-datas?date_type=week&productId=123&type=province&limit=3

返回示例

{
    "result": [
        {
            "percentage": "25.00%",
            "name": "湖南省",
            "value": 2
        },
        {
            "percentage": "25.00%",
            "name": "其他",
            "value": 2
        }
    ],
    "t": 1544411872724,
    "success": true
}

错误码

参考 错误码