元数据管理
方舟4.3.5版本中新增API

1. 获取用户属性

获取用户上报成功并且在计划中的用户属性,含系统预置但页面上隐藏的用户属性。

1.1 接口地址

【GET】 /uba/api/meta/userProperties

1.2 请求参数示例

无。
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

1.3 返回结果示例

1
[
2
{
3
//用户属性ID,唯一
4
"id":"xwho",
5
//用户属性名称,用于页面展示
6
"name":"用户ID",
7
//是否可用 1为启用 0为禁用 (通过方舟系统可以控制用户属性的可用性)
8
"enable":1,
9
//是否可见 1为可见 0为不可见(用于方舟系统,系统预置但不用于分析的属性在页面上被隐藏了)
10
"visible":1,
11
//【4.5.0中新增】是否预置属性 1为预置属性 0为自定义属性
12
"preset": 1,
13
//【4.5.0中新增】数据类型,有string、boolean、number、datetime、array<string>五种
14
"dataType": "string",
15
//【4.5.0中新增】是否有字典 1为有字典 0为未上传字典
16
"dict": 0
17
},
18
{
19
"id": "company",
20
"name": "所在公司",
21
"enable": 1,
22
//页面不可见
23
"visible": 0,
24
//自定义属性
25
"preset": 0,
26
"dataType": "string",
27
//有字典
28
"dict": 1
29
}
30
]
Copied!

1.4 接口调用示例

1
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/meta/userProperties
Copied!

2. 获取元事件列表

获取在埋点方案中并且已经回数的事件列表,含被禁用事件。

2.1 接口地址

【GET】 /uba/api/meta/event

2.2 请求参数示例

1
//【选填 5.1.0086版本新增】通过urlPath传参
2
type=event&enable=1
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

2.2.1 入参说明

参数名称
类型
必填
说明
枚举
type
String
N
事件类型,可获取所有和指定类型【5.1】
all/event/virtual
enable
Integer
N
是否回数:1为已回数 0为未回数【5.1】
0/1

2.3 返回结果示例

1
[
2
{
3
//事件ID,唯一
4
"id":"$startup",
5
//事件名称,用于页面展示
6
"name":"启动",
7
//是否可用 1为启用 0为禁用 (通过方舟系统可以控制事件的可用性)
8
"enable":1,
9
//备注,描述事件的作用
10
"remark":"APP启动 / 打开网站",
11
//【4.5.0中新增】是否预置事件 1为预置事件 0为自定义事件
12
"preset": 1,
13
//【4.6中新增】回数平台,多个值之间逗号隔开
14
"platform": "Android,iOS,JS",
15
//【5.1.0086中新增】事件类型
16
"type":"event",
17
//【5.1.0086中新增】如果是虚拟事件,则会返回虚拟事件的创建规则
18
"content":null
19
},
20
{
21
"id":"$end",
22
"name":"关闭",
23
//禁用
24
"enable":0,
25
"remark":"APP关闭 / 关闭网页",
26
"preset": 1,
27
"platform": "Android,iOS",
28
"type":"event",
29
"content":null
30
},
31
{
32
"id": "login",
33
"name": null,
34
"enable": 1,
35
"remark": null,
36
//自定义
37
"preset": 0,
38
"platform": "Android",
39
//虚拟事件
40
"type":"virtual",
41
//虚拟事件的创建规则
42
"content":{}
43
}
44
]
Copied!
如果是虚拟事件,则会返回虚拟事件的创建规则,格式如下:
1
{
2
"events": [
3
{
4
//包含的事件
5
"expression": "event.$startup",
6
//事件需要满足的条件
7
"filter": {
8
"conditions": [
9
{
10
"expression": "event.$startup.$platform",
11
"function": "EQ",
12
"params": [
13
"JS"
14
]
15
}
16
],
17
"relation": "AND"
18
}
19
},
20
{
21
"expression": "event.$pageview"
22
}
23
],
24
"relation": "OR"
25
}
Copied!

2.4 接口调用示例

1
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/meta/event
Copied!

3. 获取事件属性

获取事件的属性列表,包含事件自定义属性通用属性两种,自定义属性需要自己埋点上报,通用属性由方舟系统自动采集。

3.1 接口地址

【GET】 /uba/api/meta/eventProperties

3.2 请求参数示例

1
//【必填】通过urlPath传参
2
eventId=?
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

3.3 返回结果示例

1
[
2
{
3
//事件属性ID
4
"id":"$is_first_time",
5
//事件属性名称,用于页面展示
6
"name":null,
7
//是否可用 1为启用 0为禁用 (通过方舟系统可以控制事件属性的可用性)
8
"enable":1,
9
//是否通用属性,1为通用属性 0为事件定义属性
10
"global":0,
11
//【4.5.0中新增】是否事件预置属性 1为预置属性 0为自定义属性
12
"preset": 1,
13
//【4.5.0中新增】数据类型,有string、boolean、number、datetime、array<string>五种
14
"dataType": "boolean",
15
//【4.5.0中新增】是否有字典 1为有字典 0为未上传字典
16
"dict": 0
17
},
18
{
19
"id":"$platform",
20
"name":"平台",
21
//属性可用
22
"enable":1,
23
//通用属性(通用属性表示每个事件都有这个属性)
24
"global":1,
25
"preset":1,
26
"dataType": "string",
27
"dict": 0
28
}
29
]
Copied!
global: 0为事件自定义属性,1为通用属性。

3.4 接口调用示例

1
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/meta/eventProperties?eventId=%24startup
Copied!

4. 创建虚拟属性

上报的元事件无法直接满足分析需求,组要组合使用事件时,可以使用虚拟事件。虚拟事件可以组合多个元事件,每个元事件下也可以设置过滤条件,事件之间关系为或。在 5.1.0221 版本中新增。

4.1 接口地址

【POST】 /uba/api/meta/event/virtual

4.2 请求参数示例

1
{
2
//【必填】虚拟事件ID,唯一,并且不能和元事件ID重名,由字母、数字和下划线组成,不能以数字开头,总长度不超过100个字符
3
"id":"vactive",
4
//虚拟事件名称,长度不能超过 50
5
"name":"活跃用户",
6
//虚拟事件说明,长度不能超过 100
7
"remark":"使用过APP或者浏览过web网站的用户",
8
//【必填】虚拟事件包含的元事件
9
"events":[
10
{
11
//包含的元事件 不含条件
12
"expression":"event.$startup"
13
},
14
{
15
//包含的元事件 含条件
16
"expression":"event.$pageview",
17
//事件需要满足的条件(平台=JS的页面浏览事件)
18
"filter":{
19
"conditions":[
20
{
21
//条件表达式
22
"expression":"event.$pageview.$platform",
23
"function":"EQ",
24
"params":[
25
"JS"
26
]
27
}
28
],
29
"relation":"AND"
30
}
31
}
32
]
33
}
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

4.3 返回结果示例

1
{"success":0}
Copied!

4.4 接口调用示例

1
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
2
"id":"$vactive",
3
"name":"活跃用户",
4
"remark":"使用过APP或者浏览过web网站的用户",
5
"events":[
6
{
7
"expression":"event.$startup"
8
},
9
{
10
"expression":"event.$pageview"
11
}
12
]
13
}' http://127.0.0.1:4005/uba/api/meta/event/virtual
Copied!

5. 修改虚拟属性

支持修改虚拟事件的名称、描述、规则内容。在 5.1.0221 版本中新增。
虚拟事件修改规则是只能修改自己创建的虚拟事件,如果API不带loginUser参数只能修改通过API创建并且未带loginUser的虚拟事件。如果带loginUser参数,就能修改对应用户创建的虚拟事件。

5.1 接口地址

【PUT】 /uba/api/meta/event/virtual

5.2 请求参数示例

1
{
2
//【必填】虚拟事件ID,因为事件ID不允许修改,所以ID会作为修改条件
3
"id":"vactive",
4
//虚拟事件名称,长度不能超过 50,如果不需要修改名称,可以不传此列
5
"name":"活跃用户",
6
//虚拟事件说明,长度不能超过 100,如果不需要修改描述,可以不传此列
7
"remark":"使用过APP或者浏览过web网站的用户",
8
//虚拟事件包含的元事件,如果规则不需要发生改变,可以不传
9
"events":[
10
{
11
//包含的元事件 不含条件
12
"expression":"event.$startup"
13
},
14
{
15
//包含的元事件 含条件
16
"expression":"event.$pageview"
17
}
18
]
19
}
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

5.3 返回结果示例

1
{"success":0}
Copied!

5.4 接口调用示例

1
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X PUT --data '{
2
"id":"$vactive",
3
"name":"活跃用户"
4
}' http://127.0.0.1:4005/uba/api/meta/event/virtual
Copied!
最近更新 1yr ago