# 指标查询 API
调用方法请参见Open API文档中的调用方法描述。
建议先阅读 TE 使用手册了解项目管理相关功能：指标
# 查询可用指标列表
根据条件查询指标的定义
接口 URL
/open/metric-list?token=xxx
请求方式
POST
Content-Type
application/json
请求 Query 参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
请求body参数说明
{
"projectId": 102,
"metricName": "retention_1", //指标名称-支持模糊匹配
"metricDesc": "次日留存" // 指标显示-支持模糊匹配
"metricModes" ["EVENT","RETENTION"]， // 指标创建来源
"createUser":"root"， //创建人
"updateUser":"root", //最后修改人
"timeParticleSize":"day" //指标支持的时间粒度
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| projectId | 102 | Integer | 是 | 项目ID |
| metricName | retention_1 | String | 否 | 指标名称-支持模糊匹配 |
| metricDesc | 次日留存 | String | 否 | 指标显示名称-支持模糊匹配 |
| metricModes | ["EVENT", "RETENTION"] | List | 否 | 指标创建来源 EVENT-事件指标 RETENTION-留存指标 |
| createUser | root | String | 否 | 指标创建人登陆名称 |
| updateUser | root | String | 否 | 指标修改人登陆名称 |
| timeParticle | day | String | 否 | 指标支持的时间单位 minute：按1分钟 minute5：按5分钟（v3.5开始支持） minute10：按10分钟（v3.5开始支持） hour：按小时 day：按天 week：按周 month：按月 total：总计 |
响应参数说明
{
"data":
[
{
"metricId": 1,
"projectId": 2,
"metricName": "retention_1",
"metricDesc": "次日留存",
"metricRemark": "注册用户次日留存",
"metricMode": "EVENT",
"createUser": "root",
"updateUser": "root",
"createTime": "2022-12-12 10:10:00",
"updateTime": "2022-12-12 10:10:00",
"timeParticles":[ "minute"],
"format": "FORMAT_FLOAT"
}
],
"return_code": 0,
"return_message": "success"
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| data | - | 返回结果 | |
| ∟ metricId | 1 | Long | 指标Id |
| ∟ projectId | 102 | Integer | 指标所属项目Id |
| ∟ metricName | retention_1 | String | 指标名称 |
| ∟ metricDesc | 次日留存 | String | 指标显示名称 |
| ∟ metricRemark | 注册用户次日留存 | String | 指标备注 |
| ∟ metricMode | RETENTION | String | 指标创建来源 |
| ∟ createUser | root | String | 指标创建用户 |
| ∟ updateUser | root | String | 指标修改用户 |
| ∟ createTime | 2022-12-12 10:10:00 | Date | 指标创建日期 |
| ∟ updateTime | 2022-12-12 10:10:00 | Date | 指标修改日期 |
| ∟ timeParticles | ['day', 'hour', 'month'] | List | 指标支持的时间单位 minute：按1分钟 minute5：按5分钟（v3.5开始支持） minute10：按10分钟（v3.5开始支持） hour：按小时 day：按天 week：按周 month：按月 total：总计 |
| ∟ format | FORMAT_FLOAT | String | 指标格式 FORMAT_FLOAT：两位小数 FORMAT_FLOAT2：三位小数 FORMAT_FLOAT4：四位小数 FORMAT_INTEGER：整数 FORMAT_PERCENT：百分比 |
| return_code | 0 | Integer | 返回码 |
| return_message | success | String | 返回信息 |
# 查询指标数据
接口 URL
/open/metric-data?token=xxx
请求方式
POST
Content-Type
application/json
请求 Query 参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
请求 Body 参数
{
"eventView": {
"comparedByTime": true,
"comparedStartTime": "2021-12-14 00:00:00",
"comparedEndTime": "2021-12-20 23:59:59",
"comparedRecentDay": "8-14",
"startTime": "2021-12-21 00:00:00",
"endTime": "2021-12-27 23:59:59",
"recentDay": "1-7",
"timeParticleSize": "day",
"groupBy": [{
"columnDesc": "品牌",
"columnName": "brand",
"propertyRange": "",
"specifiedClusterDate": "2021-12-28",
"tableType": "event"
}],
"relation": "and",
"filts": [{
"columnDesc": "品牌",
"columnName": "brand",
"comparator": "equal",
"filterType": "SIMPLE",
"ftv": ["苹果", "小米"],
"specifiedClusterDate": "2021-12-28",
"tableType": "event",
"timeUnit": ""
}],
"queryFeature": {
"approximateOn": true,
"globalQueryOn": false
}
},
"metrics":["retention_1","dau"]
"zoneOffset": 0
"projectId": 377,
"useSameResultKey": false,
"useCache": true,
"limit": 1000,
"timeoutSeconds": 10
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| eventView | - | Object | 是 | 指标公共属性部分 |
| ∟ comparedByTime | true | Boolean | 否 | 是否对比时间，TRUE：是，FALSE：否 |
| ∟ comparedStartTime | 2021-12-14 00:00:00 | String | 否 | 对比时间开始时间（格式：yyyy-MM-dd HH:mm:ss），对比时间相对时间为空时有效 |
| ∟ comparedEndTime | 2021-12-20 23:59:59 | String | 否 | 对比时间结束时间（格式：yyyy-MM-dd HH:mm:ss），对比时间相对时间为空时有效 |
| ∟ comparedRecentDay | 8-14 | String | 否 | 对比时间相对时间（comparedByTime为TRUE时，此项不可与对比时间起始时间和对比时间结束时间同时为空） |
| ∟ startTime | 2021-12-21 00:00:00 | String | 否 | 起始时间（格式：yyyy-MM-dd HH:mm:ss），相对时间为空时有效 |
| ∟ endTime | 2021-12-27 23:59:59 | String | 否 | 结束时间（格式：yyyy-MM-dd HH:mm:ss），相对时间为空时有效 |
| ∟ recentDay | 1-7 | String | 否 | 相对时间（此项不可与起始时间和结束时间同时为空） |
| ∟ relation | and | String | 否 | 逻辑关系，and：逻辑与，or：逻辑或 |
| ∟ timeParticleSize | day | String | 是 | 分析的时间单位 minute：按1分钟 minute5：按5分钟（v3.5开始支持） minute10：按10分钟（v3.5开始支持） hour：按小时 day：按天 week：按周 month：按月 total：总计 |
| ∟ groupBy | - | List | 否 | 分组属性，可以有零个或者多个 |
| ∟ columnName | brand | String | 是 | 字段名 |
| ∟ columnDesc | 品牌 | String | 否 | 字段显示名 |
| ∟ propertyRange | String | 否 | 自定义属性区间 | |
| ∟ propertyRangeType | String | 否 | 属性区间类型，对数值型属性进行分组时，可以为自定义分桶条件 def：默认区间，由系统自动划分 discrete：每个值为一个独立的分组 user_defined：用户自定义。自定义内容设置在 propertyRange 中 | |
| ∟ specifiedClusterDate | 2021-12-28 | String | 否 | 指定对应日期的标签历史版本 |
| ∟ tableType | event | String | 是 | 表类型枚举值 |
| ∟ filts | - | List | 否 | 全局筛选项 |
| ∟ columnDesc | 品牌 | String | 否 | 字段显示名 |
| ∟ columnName | brand | String | 是 | 字段名 |
| ∟ comparator | equal | String | 是 | 参考： 模型查询API的 筛选表达式 |
| ∟ filterType | SIMPLE | String | 否 | 过滤模式，SIMPLE：简单，COMPOUND：复合，默认SIMPLE |
| ∟ ftv | ["苹果", "小米"] | List | 否 | 用于属性比较边界的字面常量 |
| ∟ specifiedClusterDate | 2021-12-28 | String | 否 | 指定对应日期的标签历史版本 |
| ∟ tableType | event | String | 是 | 表类型枚举值 |
| ∟ timeUnit | String | 否 | 属性对比值单位，仅对relativeEvent*有效：day，hour，minute | |
| ∟ queryFeature | - | Object | 否 | 查询配置 |
| ∟ approximateOn | true | Boolean | 否 | 是否开启近似计算 |
| metrics | ["retention_1","dau"] | list | 是 | 指标名称列表 |
| projectId | 377 | Integer | 是 | 项目Id |
| zoneOffset | 0 | Integer | 否 | 使用时区 |
| useCache | true | Boolean | 否 | 使用缓存，可选参数，默认为true |
| limit | 1000 | Integer | 否 | 每分析对象的分组数上限，可选参数，默认为1000，最大为10000 |
| timeoutSeconds | 10 | Integer | 否 | 请求超时参数，超时则取消查询任务 |
成功响应示例
{
"data": {
"result_generate_time": "2021-12-30 11:15:41",
"union_groups": [
[
"Safari",
"苹果"
],
[
"Firefox",
"小米"
],
[
"微信内置浏览器",
"苹果"
],
[
"总体",
"苹果"
],
[
"总体",
"小米"
]
],
"x": [
"2021-12-23",
"2021-12-24",
"2021-12-25",
"2021-12-26",
"2021-12-27",
"2021-12-28",
"2021-12-29"
],
"x_compared": [
"2021-12-16",
"2021-12-17",
"2021-12-18",
"2021-12-19",
"2021-12-20",
"2021-12-21",
"2021-12-22"
],
"y": [
{
"retention_1": [
{
"group_cols": [
"Safari",
"苹果"
],
"group_num": 3,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"447",
"980",
"1584",
"321",
"285",
"74",
"0"
]
},
{
"group_cols": [
"Firefox",
"小米"
],
"group_num": 3,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"291",
"818",
"1128",
"272",
"219",
"58",
"0"
]
},
{
"group_cols": [
"微信内置浏览器",
"苹果"
],
"group_num": 3,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"231",
"500",
"764",
"214",
"155",
"35",
"0"
]
}
]
},
{
"dau": [
{
"group_cols": [
"总体",
"苹果"
],
"group_num": 2,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"640",
"811",
"1251",
"1253",
"720",
"113",
"0"
]
},
{
"group_cols": [
"总体",
"小米"
],
"group_num": 2,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"277",
"439",
"600",
"666",
"364",
"59",
"0"
]
}
]
}
]
},
"return_code": 0,
"return_message": "success"
}
响应参数说明
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| data | - | Object | 返回结果 |
| ∟ result_generate_time | 2021-12-29 12:00:00 | String | 查询结果生成时间 |
| ∟ union_groups | ["苹果"] | List | 所有分组集合 |
| ∟ x | ["2021-12-23"] | List | X轴时间 |
| ∟ x_compared | ["2021-12-16"] | List | X轴对比时间 |
| ∟ y | - | List | Y轴数据列表 |
| ∟ {指标名称} | - | List | Y轴指标信息列表 |
| ∟ group_cols | ["苹果"] | List | Y轴指标分组 |
| ∟ group_num | 3 | Integer | Y轴指标分组数量 |
| ∟ values | ["0"] | List | Y轴指标数值 |
| ∟ values_compared | ["447"] | List | Y轴时间对比指标数值 |
| return_code | 0 | Integer | 返回码 |
| return_message | success | String | 返回信息 |