---
> 方舟4.3.5版本中新增API
---
# 元数据管理
## 1. 获取用户属性
获取用户上报成功并且在计划中的用户属性,含系统预置但页面上隐藏的用户属性。
### 1.1 接口地址
> 【GET】 /uba/api/meta/userProperties
### 1.2 请求参数示例
无。
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
### 1.3 返回结果示例
```java
[
{
//用户属性ID,唯一
"id":"xwho",
//用户属性名称,用于页面展示
"name":"用户ID",
//是否可用 1为启用 0为禁用 (通过方舟系统可以控制用户属性的可用性)
"enable":1,
//是否可见 1为可见 0为不可见(用于方舟系统,系统预置但不用于分析的属性在页面上被隐藏了)
"visible":1,
//【4.5.0中新增】是否预置属性 1为预置属性 0为自定义属性
"preset": 1,
//【4.5.0中新增】数据类型,有string、boolean、number、datetime、array<string>五种
"dataType": "string",
//【4.5.0中新增】是否有字典 1为有字典 0为未上传字典
"dict": 0
},
{
"id": "company",
"name": "所在公司",
"enable": 1,
//页面不可见
"visible": 0,
//自定义属性
"preset": 0,
"dataType": "string",
//有字典
"dict": 1
}
]
```
### 1.4 接口调用示例
```java
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/meta/userProperties
```
## 2. 获取元事件列表
获取在埋点方案中并且已经回数的事件列表,含被禁用事件。
### 2.1 接口地址
> 【GET】 /uba/api/meta/event
### 2.2 请求参数示例
```java
//【选填 5.1.0086版本新增】通过urlPath传参
type=event&enable=1
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
#### **2.2.1 入参说明**
| 参数名称 | 类型 | 必填 | 说明 | 枚举 |
| ------ | ------- | -- | --------------------- | ----------------- |
| type | String | N | 事件类型,可获取所有和指定类型【5.1】 | all/event/virtual |
| enable | Integer | N | 是否回数:1为已回数 0为未回数【5.1】 | 0/1 |
### 2.3 返回结果示例
```java
[
{
//事件ID,唯一
"id":"$startup",
//事件名称,用于页面展示
"name":"启动",
//是否可用 1为启用 0为禁用 (通过方舟系统可以控制事件的可用性)
"enable":1,
//备注,描述事件的作用
"remark":"APP启动 / 打开网站",
//【4.5.0中新增】是否预置事件 1为预置事件 0为自定义事件
"preset": 1,
//【4.6中新增】回数平台,多个值之间逗号隔开
"platform": "Android,iOS,JS",
//【5.1.0086中新增】事件类型
"type":"event",
//【5.1.0086中新增】如果是虚拟事件,则会返回虚拟事件的创建规则
"content":null
},
{
"id":"$end",
"name":"关闭",
//禁用
"enable":0,
"remark":"APP关闭 / 关闭网页",
"preset": 1,
"platform": "Android,iOS",
"type":"event",
"content":null
},
{
"id": "login",
"name": null,
"enable": 1,
"remark": null,
//自定义
"preset": 0,
"platform": "Android",
//虚拟事件
"type":"virtual",
//虚拟事件的创建规则
"content":{}
}
]
```
如果是虚拟事件,则会返回虚拟事件的创建规则,格式如下:
```java
{
"events": [
{
//包含的事件
"expression": "event.$startup",
//事件需要满足的条件
"filter": {
"conditions": [
{
"expression": "event.$startup.$platform",
"function": "EQ",
"params": [
"JS"
]
}
],
"relation": "AND"
}
},
{
"expression": "event.$pageview"
}
],
"relation": "OR"
}
```
### 2.4 接口调用示例
```java
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/meta/event
```
## 3. 获取事件属性
获取事件的属性列表,包含**事件自定义属性**和**通用属性**两种,自定义属性需要自己埋点上报,通用属性由方舟系统自动采集。
### 3.1 接口地址
> 【GET】 /uba/api/meta/eventProperties
### 3.2 请求参数示例
```java
//【必填】通过urlPath传参
eventId=?
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
### 3.3 返回结果示例
```java
[
{
//事件属性ID
"id":"$is_first_time",
//事件属性名称,用于页面展示
"name":null,
//是否可用 1为启用 0为禁用 (通过方舟系统可以控制事件属性的可用性)
"enable":1,
//是否通用属性,1为通用属性 0为事件定义属性
"global":0,
//【4.5.0中新增】是否事件预置属性 1为预置属性 0为自定义属性
"preset": 1,
//【4.5.0中新增】数据类型,有string、boolean、number、datetime、array<string>五种
"dataType": "boolean",
//【4.5.0中新增】是否有字典 1为有字典 0为未上传字典
"dict": 0
},
{
"id":"$platform",
"name":"平台",
//属性可用
"enable":1,
//通用属性(通用属性表示每个事件都有这个属性)
"global":1,
"preset":1,
"dataType": "string",
"dict": 0
}
]
```
> **global**: 0为事件自定义属性,1为通用属性。
### 3.4 接口调用示例
```java
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/meta/eventProperties?eventId=%24startup
```
## 4. 创建虚拟属性
上报的元事件无法直接满足分析需求,组要组合使用事件时,可以使用虚拟事件。虚拟事件可以组合多个元事件,每个元事件下也可以设置过滤条件,事件之间关系为或。在 5.1.0221 版本中新增。
### 4.1 接口地址
> 【POST】 /uba/api/meta/event/virtual
### 4.2 请求参数示例
```java
{
//【必填】虚拟事件ID,唯一,并且不能和元事件ID重名,由字母、数字和下划线组成,不能以数字开头,总长度不超过100个字符
"id":"vactive",
//虚拟事件名称,长度不能超过 50
"name":"活跃用户",
//虚拟事件说明,长度不能超过 100
"remark":"使用过APP或者浏览过web网站的用户",
//【必填】虚拟事件包含的元事件
"events":[
{
//包含的元事件 不含条件
"expression":"event.$startup"
},
{
//包含的元事件 含条件
"expression":"event.$pageview",
//事件需要满足的条件(平台=JS的页面浏览事件)
"filter":{
"conditions":[
{
//条件表达式
"expression":"event.$pageview.$platform",
"function":"EQ",
"params":[
"JS"
]
}
],
"relation":"AND"
}
}
]
}
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
### 4.3 返回结果示例
```javascript
{"success":0}
```
### 4.4 接口调用示例
```haskell
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
"id":"$vactive",
"name":"活跃用户",
"remark":"使用过APP或者浏览过web网站的用户",
"events":[
{
"expression":"event.$startup"
},
{
"expression":"event.$pageview"
}
]
}' http://127.0.0.1:4005/uba/api/meta/event/virtual
```
## 5. 修改虚拟属性
支持修改虚拟事件的名称、描述、规则内容。在 5.1.0221 版本中新增。
虚拟事件修改规则是只能修改自己创建的虚拟事件,如果API不带loginUser参数只能修改通过API创建并且未带loginUser的虚拟事件。如果带loginUser参数,就能修改对应用户创建的虚拟事件。
### 5.1 接口地址
> 【PUT】 /uba/api/meta/event/virtual
### 5.2 请求参数示例
```java
{
//【必填】虚拟事件ID,因为事件ID不允许修改,所以ID会作为修改条件
"id":"vactive",
//虚拟事件名称,长度不能超过 50,如果不需要修改名称,可以不传此列
"name":"活跃用户",
//虚拟事件说明,长度不能超过 100,如果不需要修改描述,可以不传此列
"remark":"使用过APP或者浏览过web网站的用户",
//虚拟事件包含的元事件,如果规则不需要发生改变,可以不传
"events":[
{
//包含的元事件 不含条件
"expression":"event.$startup"
},
{
//包含的元事件 含条件
"expression":"event.$pageview"
}
]
}
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
### 5.3 返回结果示例
```java
{"success":0}
```
### 5.4 接口调用示例
```java
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X PUT --data '{
"id":"$vactive",
"name":"活跃用户"
}' http://127.0.0.1:4005/uba/api/meta/event/virtual
```
- 产品简介
- 快速上手
- Step 1 安装部署
- Step 2 激活系统创建项目
- Step 3 开启您的分析旅程
- 1. 集成 SDK
- 2. 可视化埋点
- 3. 创建分析模型
- 附:埋点方案设计
- 附:数据分析思路
- 产品更新日志
- V5.5 新增LTV分析功能等
- V5.3 UI 升级、分布分析重构、维度表动态更新、细节优化等
- V5.2 新增归因分析、消息中心、重构埋点方案、优化看数据体验……
- V5.1.0317 体验优化& Bug修复
- V5.1 升级可视化埋点、增强权限控制……
- Part I 产品功能说明
- 名词解释
- 指标说明
- 看板
- 5.3.3 看板 UI 重构
- 分析
- 事件分析
- 渠道分析
- 渠道相关名词解释
- 来源识别规则
- 搜索引擎
- 社交媒体
- 小程序场景值
- Session 分析
- Session 规则
- 实时分析
- 留存分析
- 转化漏斗
- 智能路径
- 归因分析
- 热图分析
- Web/H5 热图
- APP 热图
- 分布分析
- 间隔分析
- 属性分析
- LTV 分析
- 多主体分析
- 自定义查询
- 用户
- 用户分群
- 用户探查
- 用户标签
- 标签体系应用概览
- 标签体系
- 标签生命周期管理
- 标签加工
- 如何自定义SQL创建标签
- 单用户档案
- 运营
- 广告跟踪
- 微信小程序渠道追踪
- 预置广告媒介和渠道
- App 推广监测(Beta版本)
- 电子邮件(即将下线)
- 短信(即将下线)
- 消息通知(即将下线)
- 项目管理
- 项目概览
- 项目角色管理
- 项目成员管理
- 数据接入管理
- 埋点方案
- 可视化埋点
- 集成SDK接入数据
- 数据验证
- 用户数据导入
- 微信小程序全埋点事件定义
- 元数据管理
- 元事件
- 虚拟事件
- 事件属性
- 用户属性
- Session 管理
- 页面组管理
- 维度表
- 服务集成配置
- 监控告警
- 智能监控
- 自定义监控
- 平台管理
- 企业概览
- 项目管理
- 成员管理
- 安全设置
- 企业设置
- 日志管理
- 帐号设置
- Part II 技术文档
- 技术接入准备工作
- 部署环境检测工具
- 数据模型
- 数据格式
- 预置事件和属性
- App预置事件/属性
- JS 预置事件/属性
- 如何准确识别用户
- 如何设计埋点方案
- 分平台上报数据 vs 跨平台打通
- SDK 指南
- Android SDK
- 快速集成
- 全埋点模块
- 消息推送模块
- Android Hybrid模式
- SDK Gradle集成方式
- 多渠道打包
- 易观小工具
- 合规相关
- iOS SDK
- 快速集成
- 全埋点介绍
- iOS Hybrid模式
- 消息推送模块
- JS SDK
- 快速集成
- JS SDK基础版
- JS SDK插件
- uni-app SDK
- 快速集成
- 打包原生APP
- 开启移动端全埋点
- uni-app SDK标准版
- 微信小程序 SDK
- 快速集成
- 微信小程序标准版
- 微信小程序插件版
- 微信小程序通用框架版
- 支付宝小程序 SDK
- 支付宝小程序标准版
- 支付宝小程序通用框架版
- 字节跳动小程序 SDK
- 字节跳动小程序标准版
- 字节跳动小程序通用框架版
- 百度小程序 SDK
- 百度小程序标准版
- 百度小程序通用框架版
- 钉钉小程序 SDK
- 钉钉小程序标准版
- 钉钉小程序通用框架版
- QQ小程序 SDK
- QQ小程序标准版
- QQ小程序通用框架版
- 快应用 SDK
- 华为WeCode小程序
- WeCode SDK 标准版
- WeCode SDK插件
- PhoneGap SDK
- mPaaS SDK
- ReactNative SDK
- Flutter SDK
- Java SDK
- Python SDK
- PHP SDK
- C++ SDK
- C# SDK
- Node JS SDK
- Lua SDK
- Golang SDK
- SDK FAQ
- identify与alias的区别
- 爬虫数据如何识别?
- 页面停留如何获取时间?
- 如果获取SDK及更新日志
- 代码埋点和无埋点有什么区别
- Web页面中发现丢失某一个事件
- 自研 SDK 注意事项
- 页面时长统计功能
- 飞书小程序 SDK
- 飞书小程序标准版
- 飞书小程序通用框架版
- Unreal Engine SDK
- 数据验证
- 客户端埋点验证
- Debug 数据验证
- 数据入库验证
- 数据导入
- 接口导入
- JAVA工具包
- 标准json文件导入
- csv格式导入
- 数据导入FAQ
- 数据导出
- JAVA工具包
- 事件数据导出
- 用户数据导出
- 直接从Kafka中消费数据
- 使用程序访问数据库
- 脚本工具
- API
- 分析API
- 事件分析
- 留存分析
- 自定义查询
- 转化漏斗
- 属性分析
- Session分析
- 渠道分析
- 分布分析
- 用户API
- 分群查询
- 用户档案
- 分群管理
- 管理API
- 权限管理
- 元数据管理
- 埋点方案管理
- 维度表管理
- 运营API
- 广告跟踪
- APP推广监测
- 平台管理API
- 项目管理
- 成员管理
- 第三方登录
- OAuth2.0登录
- LDAP登录
- GDPR 合规
- Part III 常见问题
- License 许可
- 产品试用及采购
- 参与贡献