文档管理中心
API参考运动健康服务基础能力服务 API 参考REST采样数据集接口采样数据统计查询

采样数据统计查询

功能介绍

将特定数据类型或数据采集器的数据按一定规则进行聚合分组。

场景描述

指定采样数据由时间间隔进行聚合分组,返回指定数据类型的统计结果。

  • 以精确时间段duration对采样数据进行聚合分组。
  • 以天为单位对采样数据进行聚合分组。
  • 以周为单位对采样数据进行聚合分组。
  • 以月为单位对采样数据进行聚合分组。

使用约束

接口原型

承载协议

HTTPS POST

接口方向

开发者应用->Health Service Kit云

接口URL

https://health-api.cloud.huawei.com/healthkit/v2/sampleSet:polymerize

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

Request Header

展开

参数

参数类型

是否必选

描述

Content-type

String

取值为:application/json; charset=UTF-8

Authorization

String

请参见认证鉴权

说明

Bearer后面拼接空格,再拼接获取的access_token。

x-client-id

String

开放联盟分配的应用标识。服务端可以基于其进行灰度路由,建议携带。

x-version

String

接口调用方的软件版本号。即当前客户端版本号,服务端可以基于其进行灰度,建议携带。

x-caller-trace-id

String

请求跟踪ID。用于串联服务调用方与服务端整体请求链条,建议携带。

Request Body

展开

参数

参数类型

是否必选

说明

约束条件

startTime

Long

期望被聚合的数据开始时间。

单位:毫秒

13位整数的时间戳,不早于1388505600000(20140101)。

endTime

Long

期望被聚合的数据结束时间。

单位:毫秒

13位整数的时间戳。

endTime需大于startTime。

endTime与startTime时间间隔不能超过31天。

polymerizeWith

List<PolymerizeWith>

聚合数据的标准。

至少提供一个聚合标准。

每个聚合标准产生一个汇总采样数据集。

List最大容量:20。

请参见PolymerizeWith数据模型。

groupByTime

GroupByTime

指定数据由时间间隔聚合数据。

请参见GroupByTime数据模型。

请求示例

POST
https://health-api.cloud.huawei.com/healthkit/v2/sampleSet:polymerize
Content-Type: application/json
Authorization: Bearer ***
x-client-id: ***
x-version: ***
x-caller-trace-id: ***
{
 "polymerizeWith": [
   {
     "dataTypeName": "com.huawei.continuous.steps.delta"
   }
 ],
 "endTime": 1563330660000,
 "startTime": 1563157860000,
 "groupByTime": {
   "duration": 86400000
 }
}

响应参数

状态码为200时:

Response Header

展开

参数

参数类型

是否必选

描述

Content-Type

String

取值为:application/json; charset=UTF-8

x-health-app-privacy

int

用户隐私标记取值为:

  • 1:用户在运动健康App已授权
  • 2:用户在运动健康App未授权
  • 3:非华为运动健康App用户(无需授权)

Response Body

展开

参数

参数类型

是否必选

描述

group

List<Group>

包含汇总数据的组列表。请参见Group数据模型。

响应示例

HTTP/1.1 200 OK
Content-type: application/json;charset=utf-8
x-health-app-privacy: 1
{
    "group": [
        {
            "startTime": 1563157860000,
            "endTime": 1563244260000,
            "sampleSet": [
                {
                    "dataCollectorId": "ZGVyaXZlZDpjb250aW51b3VzLnN0ZXBzLnRvdGFsEwMTI3ODUwMTpqEF7rB3uBcGykpv6T2TisfTMhfZAvz1BP2Kcz70d1Sg",
                    "samplePoints": [
                        {
                            "startTime": 1563157860000000000,
                            "endTime": 1563157860000000000,
                            "dataTypeName": "com.huawei.continuous.steps.total",
                            "originalDataCollectorId": "cmF3OmNjb250aW51b3VzLnN0ZXBzLmRlbHRhEwMTI3ODUwMTpqEF7rB3uBcGykpv6T2TisfTMhfZAvz1BP2Kcz70d1Sg",
                            "value": [
                                {
                                    "fieldName": "steps",
                                    "integerValue": 56
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "startTime": 1563244260000,
            "endTime": 1563330660000,
            "sampleSet": [
                {
                    "dataCollectorId": "ZGVyaXZlZDpjb250aW51b3VzLnN0ZXBzLnRvdGFsEwMTI3ODUwMTpqEF7rB3uBcGykpv6T2TisfTMhfZAvz1BP2Kcz70d1Sg",
                    "samplePoints": []
                }
            ]
        }
    ]
}

错误码

请参见错误码

在 API参考 中进行搜索
请输入您想要搜索的关键词