分布分析
方舟5.2版本中新增分布分析API

1. 接口地址

【POST】 /uba/api/distributions/analyze

2. 请求参数示例

接口请求参数,更多参数说明参照 查询API 中的 通用参数 说明。
1
{
2
//【必填】 时间范围-开始时间
3
"fromDate":"2019-06-17",
4
//【必填】 时间范围-结束时间
5
"toDate":"2019-06-18",
6
// 【必填】基础指标 可以输入多个
7
"measure":{
8
//【必填】事件/事件属性表达式
9
"expression":"event.$Anything",
10
//【必填】聚合操作符
11
"aggregator":"TOTAL_COUNT"
12
},
13
// 针对于所有步骤事件的过滤条件,非必填
14
"filter":{
15
"conditions":[
16
{
17
"expression":"event.$Anything.$platform",
18
"function":"EQ",
19
"params":[
20
"JS",
21
"Android"
22
]
23
}
24
],
25
"relation":"AND"
26
},
27
//【必填】用户分群
28
"crowds":[
29
"$ALL"
30
],
31
//抽样 这里表示全量
32
"samplingFactor":1,
33
//【选填】 unit分为按照全部、日(DAY)、周(WEEK)、月(MONTH)查看,为空时表示按照全部查看
34
"unit":"",
35
//按XX维度查看,只支持单个维度,不传表示不按维度细分
36
"byField":{
37
"expression":"event.$Anything.$platform"
38
},
39
//是否使用缓存
40
"useCache":true,
41
"limit":50
42
}
Copied!
特殊说明:
1、参数在示例中未标注必填的表示选填。
2、请求参数可以通过方舟产品生成,具体参照 接口请求参数获取
3、细分维度只支持单维度查看,不支持分群对比。
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

2.1 聚合表达式说明

aggregator:聚合表达式,根据指标表达式是事件和属性而不同。
  • 事件表达式支持的聚合操作符如下:
    • TOTAL_COUNT: 次数,行为触发次数。
    • DISTRIBUTION_TIME:时间,分布时间点。
  • 属性表达式支持的聚合操作符如下:
    • REMOVE_DUMPLICATE :表示去重数,支持所有数据类型。
    • SUM:总和,选定属性的属性值求和,例如加入购物车的商品金额之和,只支持数值类型。
    • AVG:均值,选定属性的属性值算数平均数,例如加入购物车的商品金额均值,只支持数值类型。
    • MAX: 最大值,选定属性的属性值最大值,例如加入购物车的商品最大金额,只支持数值类型。
    • MIN :最小值,选定属性的属性值最小值,例如加入购物车的商品最小金额,只支持数值类型。
    • AVG_PER: 人均值,选定属性的属性值人均值,例如人均加入购物车的商品金额,只支持数值类型。‌

3. 返回结果示例

1
{
2
//查询的指标,和输入一致
3
"measure": "event.$startup.$browser_version.REMOVE_DUMPLICATE",
4
//查看维度,和输入一致
5
"byField": null,
6
//区间值
7
"series": [
8
"[1,2)",
9
"[2,5)"
10
],
11
"rows": [
12
{
13
//对应byvalue的总用户数
14
"sum": 3,
15
//用户数,根据下标和区间值(series)对应
16
"values": [
17
2,
18
1
19
],
20
//维度结果(按照维度查看就是对应的维度就结果,按照日查看就是日期)如果等于all说明是按全部查看
21
"byValue": "2020/09/02 00:00:00"
22
},
23
{
24
"sum": 2,
25
"values": [
26
1,
27
1
28
],
29
"byValue": "2020/08/28 00:00:00"
30
},
31
{
32
"sum": 2,
33
"values": [
34
1,
35
1
36
],
37
"byValue": "2020/08/31 00:00:00"
38
},
39
{
40
"sum": 1,
41
"values": [
42
0,
43
1
44
],
45
"byValue": "2020/08/27 00:00:00"
46
},
47
{
48
"sum": 1,
49
"values": [
50
0,
51
1
52
],
53
"byValue": "2020/09/01 00:00:00"
54
}
55
],
56
//查询时间
57
"reportUpdateTime": "2020-09-03 11:49:26"
58
}
Copied!

4. 接口调用示例

1
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
2
"measure": {
3
"expression": "event.$startup.$browser_version",
4
"aggregator": "REMOVE_DUMPLICATE"
5
},
6
"toDate": "2020-09-02",
7
"fromDate": "2020-08-27",
8
"unit": "DAY",
9
"useCache": true,
10
"samplingFactor": 1,
11
"limit": 50,
12
"crowds": [
13
"$ALL"
14
]
15
}' http://127.0.0.1:4005/uba/api/distributions/analyze
Copied!
最近更新 1yr ago