*****
> 方舟5.3.3版本中新增维度表管理相关API。
*****
# 维度表管理
## 1\. 获取维度表字段
获取某个维度表下的所有字段。
### 1.1 接口地址
> 【GET】 /uba/api/project/dimensions/properties
### 1.2 请求参数示例
```java
//【必填】通过urlPath传参,table为维度表名称
table=?
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
### 1.3 返回结果示例
```java
[
{
//字段名
"id": "dim_product_id",
//数据类型
"dataType": "number",
//字段显示名称
"name": null,
//字段说明
"remark": null,
//是否启用 1为启动 0为禁用
"enable": 1,
//是否为关联字段 1为关联字段 0为非关联字段
"relation": 1
},
{
"id": "name",
"dataType": "string",
"name": null,
"remark": null,
"enable": 1,
//0表示非关联字段
"relation": 0
},
{
"id": "price",
"dataType": "number",
"name": null,
"remark": null,
"enable": 1,
"relation": 0
}
]
```
### 1.4 接口调用示例
```
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/project/dimensions/properties?table=dim_product
```
## 2\. 更新维度表
更新维度表中的数据,维度表必须是已经创建成。接口支持新增列和往表中添加数据。
### 2.1 接口地址
> 【POST】 /uba/api/project/dimensions/update
### 2.2 请求参数示例
```java
{
//【必填】维度表名称,维度表必须存在
"table":"dim_product",
//【必填】需要上报数据的维度表字段和字段对应的类型,map结构,key为字段名,value为字段类型
"columns":{
//dim_product_id为字段名 number为数据类型
"dim_product_id":"number",
"name":"string",
"price":"number"
},
//【必填】维度属性值,可以多条
"rows":[
{
//一行值为map结构,key为字段名,value为字段对应的值,dim_product_id为列名,1为dim_product_id字段的值
"dim_product_id":1,
"name":"华为meta8",
"price":4999
},
{
"dim_product_id":11,
"name":"小米 K30",
"price":2699
}
]
}
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
> \*\*columns:\*\*维度表中的字段名和字段数据类型。
> 参数为map结构,key为字段名,value为字段对应的数据类型。数据类型支持:
> * **string**:字符串;
> * **number**:数值,包含整数和小数点数据;
> * **boolean**:布尔,只包含 true/false;
> * **datetime**:日期,如yyyy-MM-dd HH:mm:ss.SSS 或yyyy-MM-dd HH:mm:ss 或yyyy-mm-dd;
> * **array<string>**:集合,字符串集合。
> \*\*rows:\*\*要插入到维度表中的数据,一行一条记录,每条记录用map存储,key为字段名,value为字段对应的值,关联字段值不能为空。rows中的字段在columns中必须定义。
{% hint style="info" %}
columns中必须包含维度表关联字段,并且关联字段在rows中的值不能为空;
如果数据库中已有的维度表字段数据类型和columns传入的不一致,会提示参数错误;
如果rows中指定的column在columns中没有指定字段的类型,会提示参数错误。
{% endhint %}
### 2.3 返回结果示例
```
{
"success":0
}
```
### 2.4 接口调用示例
```haskell
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
"table":"dim_product",
"columns":{
"dim_product_id":"number",
"name":"string",
"price":"number"
},
"rows":[
{
"dim_product_id":1,
"name":"华为meta8",
"price":4999
},
{
"dim_product_id":11,
"name":"小米 K30",
"price":2699
}
]
}' http://127.0.0.1:4005/uba/api/project/dimensions/update
```
## 3 创建维度表
创建维度表,维度表必须不存在,第一次创建维度表时需要指定表名、关联字段、表字段并且至少包含一条初始化数据。
### 3.1 接口地址
> 【POST】 /uba/api/project/dimensions
### 3.2 请求参数示例
```java
{
//【必填】维度表名称,维度表必须存在
"table":"dim_product",
//维度表展示名称,不能超过200个字符
"showName":"产品属性",
//关联字段
"relations":[
"dim_product_id"
],
//备注信息,不能超过200个字符
"remark":"",
//【必填】需要上报数据的维度表字段和字段对应的类型,map结构,key为字段名,value为字段类型
"columns":{
//dim_product_id为字段名 number为数据类型
"dim_product_id":"number",
"name":"string",
"price":"number"
},
//【必填】维度属性值,可以多条
"rows":[
{
//一行值为map结构,key为字段名,value为字段对应的值,dim_product_id为列名,1为dim_product_id字段的值
"dim_product_id":1,
"name":"华为meta8",
"price":4999
},
{
"dim_product_id":11,
"name":"小米 K30",
"price":2699
}
]
}
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
> **relations**:关联字段,可以指定多个,最多不能超过
> **columns:** 维度表中的字段名和字段数据类型。
> 参数为map结构,key为字段名,value为字段对应的数据类型。数据类型支持:
> * **string**:字符串;
> * **number**:数值,包含整数和小数点数据;
> * **boolean**:布尔,只包含 true/false;
> * **datetime**:日期,如yyyy-MM-dd HH:mm:ss.SSS 或yyyy-MM-dd HH:mm:ss 或yyyy-mm-dd;
> * **array<string>**:集合,字符串集合。
> **rows:** 要插入到维度表中的数据,一行一条记录,每条记录用map存储,key为字段名,value为字段对应的值,关联字段值不能为空。rows中的字段在columns中必须定义。
>[info] columns中必须包含维度表关联字段,并且关联字段在rows中的值不能为空;
> 如果数据库中已有的维度表字段数据类型和columns传入的不一致,会提示参数错误;
> 如果rows中指定的column在columns中没有指定字段的类型,会提示参数错误。
### 3.3 返回结果示例
```
{
"success":0
}
```
### 3.4 接口调用示例
```haskell
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
"table":"dim_product",
"showName":"商品维度表",
"relations":[
"dim_product_id"
],
"columns":{
"dim_product_id":"number",
"name":"string",
"price":"number"
},
"rows":[
{
"dim_product_id":1,
"name":"华为meta8",
"price":4999
},
{
"productId":11,
"name":"小米 K30",
"price":2699
}
]
}' http://127.0.0.1:4005/uba/api/project/dimensions
```
## 4\. 清空维度表
清空维度表中的所有记录。清空后维度表和字段都还存在,页面还可继续使用,但是表中没有任何一条记录,数据不可恢复。
### 4.1 接口地址
> 【DELETE】 /uba/api/project/dimensions/clear
### 4.2 请求参数示例
```
//【必填】通过urlPath传参,table为维度表名称
table=?
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
### 4.3 返回结果示例
```
{
"success":0
}
```
### 4.4 接口调用示例
```
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X DELETE http://127.0.0.1:4005/uba/api/project/dimensions/clear?table=dim_product
```
## 5\. 删除维度表
删除维度表。删除后维度表和维度表的记录都会被删除,不可恢复。删除后维度表将不存在,页面也不能再继续使用。
### 5.1 接口地址
> 【DELETE】 /uba/api/project/dimensions/drop
### 5.2 请求参数示例
```
//【必填】通过urlPath传参,table为维度表名称
table=?
```
> **认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../#21-xiang-mu-jie-kou-ren-zheng)。
### 5.3 返回结果示例
```
{
"success":0
}
```
### 5.4 接口调用示例
```
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X DELETE http://127.0.0.1:4005/uba/api/project/dimensions/drop?table=dim_product
```
- 产品简介
- 快速上手
- 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 许可
- 产品试用及采购
- 参与贡献