Tuya.com
简体中文
English
注册
登录开发者平台
简体中文
English
注册
登录开发者平台
云服务 API 参考（归档）
search
根据文档目录筛选
云服务 API 参考（归档）全屋智能 API数据星象仪API其他API

数据星象仪API

更新时间：2023-06-19 07:06:14

本文介绍数据服务相关接口。

API 列表

请求方式 API 描述
GET /v1.0/statistics-datas-survey 获取数据总体概况
GET /v1.0/apps/{schema}/users-active-datas 统计 App 日注册用户数
GET /v1.0/apps/{schema}/users-live-datas 统计 App 日活跃用户数
GET /v1.0/apps/{schema}/devices-survey 获取 App 设备数据概况
GET /v1.0/devices/datas-survey 获取设备总体概况
GET /v1.0/devices/locations-live-datas 获取活跃设备地区分布数据
GET /v1.0/devices/locations-active-datas 获取激活设备地区分布详情数据
GET /v1.0/devices/live-datas 统计设备日活跃数
GET /v1.0/devices/active-datas 统计设备日激活数
GET /v1.0/devices/accumulate-active-datas 统计设备日累计激活数据
GET /v1.0/devices/live-datas-survey 获取设备活跃数据概况
GET /v1.0/devices/active-datas-survey 获取设备激活数据概况

获取数据总体概况

功能描述

获取数据总体概况。

接口地址

GET /v1.0/statistics-datas-survey

请求参数

参数名 类型 参数类型 必填 说明
product_id String URL 否 产品 ID，不填写则获取用户所有产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

说明：result 返回的值为 null 时，不显示。

Result

参数名 类型 说明
dev_active Object 设备激活数据概况
App_register Object App 用户数据概况
user_feedback Object 用户反馈概况
dev_fault Object 设备故障概况

DevActive

参数名 类型 说明
today_active String 当天激活设备数
yesterday_active String 昨天激活设备数
all_activate String 累计激活设备数
near7_day_active String 近 7 天激活设备数
last7_day_active String 上一个近 7 天激活设备数 （从近7天到近14天期间的数据）
compared_with_yesterday_active String 当天激活设备数较昨日同比

AppRegister

参数名 类型 说明
today_add String 当天注册用户数
yesterday_add String 昨天注册用户数
all_add String 总注册用户数
today_live String 当天活跃用户数
yesterday_live String 昨天活跃用户数
compared_with_yesterday_add String 当天注册用户数较昨日同比
compared_with_yesterday_live String 当天活跃用户数较昨日同比

UserFeedback

参数名 类型 说明
today_feedback String 当天反馈数
all_feedback String 全部反馈数
compared_with_yesterday_feedback String 当天新增反馈数较昨日同比

DevFault

参数名 类型 说明
today_dev_fault String 当天故障设备数
yesterday_dev_fault String 昨天故障设备数
all_dev_fault String 总故障设备数
compared_with_yesterday_dev_fault String 当天新增故障设备数较昨日同比

请求示例

GET /v1.0/statistics-datas-survey?product_id=12345

返回示例

{
    "success": true,
    "t": 1545286977957,
    "result": {
        "user_feedback": {
            "all_feedback": "2",
            "compared_with_yesterday_feedback": "0%",
            "today_feedback": "0"
        },
        "dev_fault": {
            "all_dev_fault": "0",
            "yesterday_dev_fault": "0",
            "compared_with_yesterday_dev_fault": "0.00%",
            "today_dev_fault": "0"
        },
        "App_register": {
            "all_add": "7915",
            "compared_with_yesterday_live": "0.00%",
            "yesterday_add": "0",
            "today_add": "0",
            "compared_with_yesterday_add": "0.00%"
        },
        "dev_active": {
            "today_active": "0",
            "all_activate": "5237",
            "yesterday_active": "0",
            "compared_with_yesterday_active": "0.00%"
        }
    }
}

统计 App 日注册用户数

功能描述

统计 App 日注册用户数。

接口地址

GET /v1.0/apps/{schema}/users-active-datas

请求参数

参数名 类型 参数类型 必填 说明
schema String URI 是 App schema
date_type String URL 是 时间格式：
  • day：天
  • week：周
  • weeks：两周
  • month：月

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

Result

参数名 类型 说明
日期 Integer App 当天注册的用户数

请求示例

GET /v1.0/apps/smart/users-active-datas?date_type=week

返回示例

{
    "success": true,
    "t": 1544422545848,
    "result": [
        {
            "20181203": 3
        },
        {
            "20181204": 2
        },
        {
            "20181205": 2
        },
        {
            "20181206": 2
        },
        {
            "20181207": 4
        },
        {
            "20181208": 2
        },
        {
            "20181209": 0
        }
    ]
}

统计 App 日活跃用户数

功能描述

统计 App 日活跃用户数。

接口地址

GET /v1.0/apps/{schema}/users-live-datas

请求参数

参数名 类型 参数类型 必填 说明
schema String URI 是 App schema
date_type String URL 是 时间格式：
  • day：天
  • week：周
  • weeks：两周
  • month：月

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

Result

参数名 类型 说明
日期 Integer App 当天活跃的用户数

请求示例

GET /v1.0/apps/smart/users-live-datas?date_type=week

返回示例

{
    "success": true,
    "t": 1544426282187,
    "result": [
        {
            "20181203": 10
        },
        {
            "20181204": 15
        },
        {
            "20181205": 16
        },
        {
            "20181206": 13
        },
        {
            "20181207": 9
        },
        {
            "20181208": 9
        },
        {
            "20181209": 15
        }
    ]
}

获取 App 用户设备数据概况

功能描述

获取 App 设备数据概况。

接口地址

GET /v1.0/apps/{schema}/devices-survey

请求参数

参数名 类型 参数类型 必填 说明
schema String URI 是 App schema

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

说明：result 返回的值为 null 时，不显示。

Result

参数名 类型 说明
today_add String 当前app下当天激活的设备数
yesterday_add String 当前app下昨天激活的设备数
all_add String 当前app下累计激活的设备数
today_live String 当前app下当天活跃设备数
yesterday_live String 当前app下昨天活跃设备数
compared_with_yesterday_add String 当前app下当天设备激活数较昨日同比
compared_with_yesterday_live String 当前app下当天设备活跃数较昨日同比

请求示例

GET /v1.0/apps/smart/devices-survey

返回示例

{
    "success": true,
    "t": 1545286492204,
    "result": {
        "all_add": "7914",
        "compared_with_yesterday_live": "-30.00%",
        "yesterday_add": "0",
        "today_add": "0",
        "compared_with_yesterday_add": "0.00%",
        "yesterday_live": "14",
        "today_live": "7"
    }
}

获取设备总体概况

功能描述

获取设备总体概况。

接口地址

GET /v1.0/devices/datas-survey

请求参数

参数名 类型 参数类型 必填 说明
product_id String URL 否 产品 ID，不填写则获取用户所有产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

说明：result 返回的值为 null 时，不显示。

Result

参数名 类型 说明
dev_active Object 设备激活数据概况
dev_fault Object 设备故障概况
dev_live Object 设备活跃数据概况

DevActive

参数名 类型 说明
today_active String 当天激活设备数
yesterday_active String 昨天激活设备数
all_activate String 累计激活设备数
near7_day_active String 近 7 天激活设备数
last7_day_active String 上一个近 7 天激活设备数 （从近7天到近14天期间的数据）
compared_with_yesterday_active String 当天激活设备数较昨日同比

DevFault

参数名 类型 说明
today_dev_fault String 当天故障设备数
yesterday_dev_fault String 昨天故障设备数
all_dev_fault String 总故障设备数
compared_with_yesterday_dev_fault String 当天故障设备数较昨日同比

DevLive

参数名 类型 说明
today_live String 当天活跃设备数
yesterday_live String 昨天活跃设备数
near7_day_live String 近 7 天活跃设备数
last7_day_live String 上一个近 7 天活跃设备数 （从近7天到近14天期间的数据）
compared_with_yesterday_live String 当天新增活跃设备数较昨日同比
rate_of_today_live String 当天活跃数/累计激活数

请求示例

GET /v1.0/devices/datas-survey?product_id=1234

返回示例

{
    "success": true,
    "t": 1545282358411,
    "result": {
        "dev_live": {
            "compared_with_yesterday_live": "1.02%",
            "today_live": "99",
            "yesterday_live": "102",
            "rate_of_today_live": "1.89%"
        },
        "dev_active": {
            "today_active": "0",
            "all_activate": "5237",
            "yesterday_active": "0",
            "compared_with_yesterday_active": "0.00%"
        }
    }
}

获取活跃设备地区分布数据

功能描述

获取活跃设备地区分布数据。

接口地址

GET /v1.0/devices/locations-live-datas

请求参数

参数名 类型 参数类型 必填 说明
date_type String URL 是 时间格式：
  • day：天
  • week：周
  • weeks：两周
  • month：月
type String URL 是
  • province：省
  • city：市
limit Integer URL 是 返回结果。限制数，取值范围（0, 100] 。
productId String URL 否 产品 ID， 不填写则获取用户全部产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

Result

参数名 类型 说明
percentage String 地区活跃数/总活跃数
name String 地区名
value Integer 地区总活跃的设备数

请求示例

GET /v1.0/devices/locations-live-datas?date_type=week&productId=123&type=province&limit=3

返回示例

{
    "success": true,
    "t": 1544413487580,
    "result": [
        {
            "percentage": "32.31%",
            "name": "其他",
            "value": 42
        },
        {
            "percentage": "8.46%",
            "name": "臺北市",
            "value": 11
        },
        {
            "percentage": "6.92%",
            "name": "北京市",
            "value": 9
        }
    ]
}

获取激活设备地区分布详情数据

功能描述

获取激活设备地区分布详情数据。

接口地址

GET /v1.0/devices/locations-active-datas

请求参数

参数名 类型 参数类型 必填 说明
date_type String URL 是 时间格式：
  • day：天
  • week：周
  • weeks：两周
  • month：月
type String URL 是
  • country：地区（仅限中国区外使用）
  • province：省
  • city：市
limit Integer URL 是 返回结果。限制数，取值范围（0, 100] 。
productId String URL 否 产品 ID， 不填写则获取用户全部产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

Result

参数名 类型 说明
percentage String 地区激活数/总激活数
name String 地区名
value Integer 地区总激活的设备数

请求示例

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

返回示例

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

统计设备日活跃数

功能描述

统计设备日活跃数。

接口地址

GET /v1.0/devices/live-datas

请求参数

参数名 类型 参数类型 必填 说明
date_type String URL 是 时间格式：
  • day：天
  • week：周
  • weeks：两周
  • month：月
product_id String URL 否 产品 ID，不填写则获取用户所有产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

Result

参数名 类型 说明
日期 Integer 当天活跃的设备数

请求示例

GET /v1.0/devices/live-datas?date_type=week&product_id=123

返回示例

{
    "success": true,
    "t": 1544411339830,
    "result": [
        {
            "20181203": 106
        },
        {
            "20181204": 107
        },
        {
            "20181205": 109
        },
        {
            "20181206": 105
        },
        {
            "20181207": 106
        },
        {
            "20181208": 108
        },
        {
            "20181209": 132
        }
    ]
}

统计设备日激活数

功能描述

统计设备日激活数。

接口地址

GET /v1.0/devices/active-datas

请求参数

参数名 类型 参数类型 必填 说明
date_type String URL 是 时间格式：
  • day：天
  • week：周
  • weeks：两周
  • month：月
product_id String URL 否 产品 ID，不填写则获取用户所有产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

Result

参数名 类型 说明
日期 Integer 当天激活的设备数

请求示例

POST /v1.0/devices/active-datas?date_type=week&product_id=123

返回示例

{
    "success": true,
    "t": 1544410649442,
    "result": [
        {
            "20181203": 0
        },
        {
            "20181204": 3
        },
        {
            "20181205": 1
        },
        {
            "20181206": 0
        },
        {
            "20181207": 1
        },
        {
            "20181208": 2
        },
        {
            "20181209": 2
        }
    ]
}

统计设备日累计激活数据

功能描述

统计设备日累计激活数据。

接口地址

GET /v1.0/devices/accumulate-active-datas

请求参数

参数名 类型 参数类型 必填 说明
date_type String URL 是 时间格式：
  • day：天
  • week：周
  • weeks：两周
  • month：月
product_id String URL 否 产品 ID，不填写则获取用户所有产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

Result

参数名 类型 说明
日期 Integer 当天累计激活设备数

请求示例

GET /v1.0/devices/accumulate-active-datas?date_type=week&product_id=123

返回示例

{
    "success": true,
    "t": 1544409913646,
    "result": [
        {
            "20181203": 5770
        },
        {
            "20181204": 5773
        },
        {
            "20181205": 5774
        },
        {
            "20181206": 5774
        },
        {
            "20181207": 5775
        },
        {
            "20181208": 5777
        },
        {
            "20181209": 5778
        }
    ]
}

获取设备活跃数据概况

功能描述

获取设备活跃数据概况。

接口地址

GET /v1.0/devices/live-datas-survey

请求参数

参数名 类型 参数类型 必填 说明
product_id String URL 否 产品 ID，不填写则获取用户所有产品 ID。

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

说明：result 返回的值为 null 时，不显示。

Result

参数名 类型 说明
today_live String 当天活跃设备数
yesterday_live String 昨天活跃设备数
near7_day_live String 近 7 天活跃设备数
last7_day_live String 上一个近 7 天活跃设备数（从近7天到近14天期间的数据）
compared_with_yesterday_live String 当天活跃设备数较昨日同比
rate_of_today_live String 当天活跃数/累计激活数

请求示例

GET /v1.0/devices/live-datas-survey?product_id=123

返回示例

{
    "success": true,
    "t": 1545278810104,
    "result": {
        "near7_day_live": "108",
        "last7_day_live": "129",
        "today_live": "99",
        "yesterday_live": "102",
        "rate_of_today_live": "1.89%"
    }
}

获取设备激活数据概况

功能描述

获取设备激活数据概况。

接口地址

GET /v1.0/devices/active-datas-survey

请求参数

参数名 类型 参数类型 说明 必填
product_id String URL 产品 ID，不填写则获取用户所有产品 ID。 否

返回参数

参数名 类型 说明
code Integer 参见全局错误码。
success Boolean 是否成功：
  • true：成功
  • false：失败
msg String 请求失败的信息，成功为空。
result Object 返回结果。

说明：result 返回的值为 null 时，不显示。

Result

参数名 类型 说明
today_active String 当天激活设备数
yesterday_active String 昨天激活设备数
all_activate String 累计激活设备数
near7_day_active String 近 7 天激活设备数
last7_day_active String 上一个近 7 天激活设备数（从近7天到近14天期间的数据）
compared_with_yesterday_active String 当天激活设备数较昨日同比

请求示例

GET /v1.0/devices/active-datas-survey?product_id=123

返回示例

{
    "success": true,
    "t": 1545278901275,
    "result": {
        "today_active": "0",
        "last7_day_active": "8",
        "all_activate": "5237",
        "near7_day_active": "2",
        "yesterday_active": "0"
    }
}
上一篇获取设备累计激活数据趋势
下一篇全屋智能内容管理
语言
简体中文
简体中文
English
400-881-8611
7×24小时服务热线
市场合作
marketing@tuya.com
业务合作
service@tuya.com
媒体联络
pr@tuya.com
关注“涂鸦智能”
涂鸦服务尽在掌握
关注“全球智能商业”
第一时间获取物联网资讯
联系我们加入我们TuyaExpoApp 商城TuyaGoTuyaGo服务商查询
法律声明隐私协议加州隐私权利声明服务条款廉正合规安全应急响应中心
©2014-2024 杭州涂鸦信息技术有限公司 版权
浙ICP备14011795号
浙B2-20210233号
浙公网安备33010602004238号
简体中文
简体中文
English