# 分群管理
## 1. 创建分群 <a href="4-huo-qu-suo-you-yong-hu-fen-qun-lie-biao" id="4-huo-qu-suo-you-yong-hu-fen-qun-lie-biao"></a>
通过分群规则创建分群。在 4.5.0 版本中新增。
### 1.1 接口地址 <a href="41-jie-kou-di-zhi" id="41-jie-kou-di-zhi"></a>
> 【POST】 /uba/api/cohort
### 1.2 请求参数示例 <a href="42-qing-qiu-can-shu-shi-li" id="42-qing-qiu-can-shu-shi-li"></a>
```java
{
//分群名称，不允许重复
"name": "apitest1",
//动态分群
"dynamic": 0,
//分群创建规则
"content": {
"ruleGroup":[],
"relations":[]
}
}
```
> **认证参数**：接口必传token和appKey两个参数，详情见 [项目接口认证](../README.md)。
>
> **操作用户**：通过API创建的分群默认为API所有，不属于任何用户，如果想让某个用户在页面上对此分群进行操作，需要在URL上带loginUser参数，详情见 [操作用户](../#51-cao-zuo-yong-hu)。
#### 1.2.1 入参说明 <a href="4-2-1-ru-can-shuo-ming" id="4-2-1-ru-can-shuo-ming"></a>
| 参数名称 | 类型 | 必填 | 说明 | 枚举 |
| ------- | ------ | -- | ------------------------------------------------- | ---------------- |
| name | String | Y | 分群名称，不能重复 | |
| dynamic | int | Y | <p>1：为动态分群 每日凌晨计算一次</p><p>0：静态分群 在创建分群的时候计算一次</p> | <p>1</p><p>0</p> |
| content | Json | Y | 分群创建规则 | |
#### 1.2.2 创建规则说明
分群规则是多层嵌套的结构，以下针对于分群规则详情说明。
**一、规则组装**
content里面存放的是分群规则和规则之间的关系，可自由组装。
```java
"content":{
//规则，可以是多个
"ruleGroup":[
{
"rules":[
{
...
}
],
"relation":"AND"
}
],
//规则之间的逻辑关系，当前支持且和非。 且：AND，非：AND_NOT
"relations":[
"AND"
]
}
```
>[info] **规则之间的关系定位为集合类型，是为了支持规则之间的多种关系，使用如下：**
1、relations **为空**，规则之间之间逻辑关系**默认** 为 **且**。
2、relations 1个值，规则之间都使用相同逻辑关系。
3、relations 大于1个值，在规则个数大于2时使用，表示第N个和第N+1个规则之间的逻辑关系。即 relations.size = ruleGroup.size -1。
**二、规则定义**
ruleGroup 存放的规则内容的集合以及间的逻辑关系
```java
{
"ruleGroup":{
"rules":[
...
],
//规则内容之间的逻辑关系，当前支持 AND/OR 两种
"relation":"AND"
}
}
```
**三、规则内容**
规则内容当前支持用户属性规则和事件规则两种。
**用户属性规则**
```java
{
//【必填】user表示为用户属性规则
"type":"user",
//【必填】用户属性表达式
"expression":"user.$email",
//【必填】操作符，和属性数据类型相关
"function":"NOT_EQ",
// 规则条件值，根据不同的操作符可以有一个或多个，数组
"params":["XX"]
}
```
以上表示的意思是：获取 **用户邮箱不等于XX** 的用户。
> **参数说明：**
>
> * **expression：**用来指定具体事件/事件属性，更多介绍参照 [用户属性表达式](../api-analytics/#2-1-2-shu-xing-biao-da-shi)。
> * **function：**聚合操作符操作符，根据不同数据类型支持不同操作符，具体参考 [条件操作符号](../api-analytics/#2-2-2-tiao-jian-cao-zuo-fu-hao)。
> * **filter：**事件的过滤条件，具体参考 [过滤条件](../api-analytics/#22-guo-lv-tiao-jian)。
**事件规则**
```java
{
//【必填】event表示为事件规则
"type":"event",
//【必填】事件表达式/事件属性表达式
"expression":"event.$startup",
//【必填】事件发生的时间范围，和 eventRelativeTimeParam二选一.如果两个都传了会以eventAbsoluteTimeParams为准
"eventAbsoluteTimeParams":["2019-09-12","2019-09-18"],
//【必填】聚合操作符 如果是事件指定为触发次数：TOTAL_COUNT，如果是属性指定为去重数：REMOVE_DUMPLICATE
"aggregator":"TOTAL_COUNT",
//【必填】触发次数/去重数使用的操作符
"function":"GTE",
//触发次数/去重数满足的条件值
"params":[
"1"
],
//针对于这个事件的具体过滤条件
"filter":{
...
}
}
```
以上表示的意思是：获取 **2019-09-12到2019-09-18内启动次数大于1** 的用户。
> **参数说明：**
>
> * **expression：**用来指定具体事件/事件属性，更多介绍参照 [表达式](../api-analytics/#21-biao-da-shi)。
> * **eventAbsoluteTimeParams：**事件发生的时间范围，绝对时间，**数组**（length=2），内容格式为yyyy-MM-dd。
> * **eventRelativeTimeParam：**事件发生的时间范围，相对时间，在创建动态分群时使用。需要按照指定格式传入，如近七日：6,0,day，过去七日：7,1,day，今日：0 day。
> * **aggregator：**聚合操作符，分群中只支持两种：
> * **事件的触发次数：TOTAL_COUNT**
> * **事件属性的去重数：REMOVE_DUMPLICATE**
> * **function：**聚合操作符操作符，和数值类型的运算符一致（但**不支持 **NOT_NULL 和 NULL），具体参考 [条件操作符号](../api-analytics/#2-2-2-tiao-jian-cao-zuo-fu-hao)。
> * **filter：**事件的过滤条件，具体参考 [过滤条件](../api-analytics/#22-guo-lv-tiao-jian)。
### 1.3 返回结果示例 <a href="43-fan-hui-jie-guo-shi-li" id="43-fan-hui-jie-guo-shi-li"></a>
```java
{
"id": 2,
"code": "arkfq_2",
"name": "test",
"dynamic": 1,
"createTime": "2019-09-12 11:53:24",
"content": {...}
}
```
### 1.4 接口调用示例 <a href="44-jie-kou-tiao-yong-shi-li" id="44-jie-kou-tiao-yong-shi-li"></a>
```java
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
"name":"apiTest02",
"dynamic":0,
"content":{
"ruleGroup":[
{
"rules":[
{
"type":"user",
"expression":"user.xwho",
"function":"NOT_NULL",
"params":[
]
},
{
"type":"user",
"expression":"user.$email",
"function":"NOT_EQ",
"params":[
"xx1",
"xx2"
]
},
{
"type":"user",
"expression":"user.$signup_time",
"function":"RELATIVE_TIME_OF_CUURENT",
"params":[
"30",
"day",
"within"
]
}
],
"relation":"AND"
},
{
"rules":[
{
"type":"event",
"expression":"event.$startup",
"eventAbsoluteTimeParams":[
"2019-09-09",
"2019-09-15"
],
"aggregator":"TOTAL_COUNT",
"function":"GTE",
"params":[
0
]
}
],
"relation":"AND"
}
],
"relations":[
"AND"
]
}
}' http://127.0.0.1:4005/uba/api/cohort
```
## 2. 获取单个用户分群信息
获取单个用户分群信息。在 4.5.0 版本中新增。
### 2.1 接口地址
> 【GET】 /uba/api/cohort/{id}
### 2.2 请求参数示例
```java
?needMore=false
```
> **认证参数**：接口必传token和appKey两个参数，详情见 [项目接口认证](../README.md)。
#### 2.2.1 入参说明
| 参数名称 | 类型 | 必填 | 说明 | 枚举 |
| -------- | ------- | -- | ------------------------------------------- | ----------------------- |
| id | Long | Y | 分群ID | |
| needMore | Boolean | N | <p>是否需要分群的详细信息。</p><p>备注：URL传参，默认为false</p> | <p>true</p><p>false</p> |
### 2.3 返回结果示例
```java
{
//分群id 在操作某个分群时使用
"id": 2,
//分群code 在查询用户详情时需要用到分群时都通过code来筛选
"code": "arkfq_2",
//分群名称，用户页面定义
"name": "test",
//动态分群 1为动态分群 每日凌晨计算一次
"dynamic": 1,
//当前分群的用户数
"userNumber": 992,
//分群状态 success：成功，failed：失败，calculating：计算中
"status": "success",
//分群最后一次计算时间
"calculatedTime": "2019-09-12 11:53:29"
}
```
如果URL上传参 needMore=true，则返回参数中会多一下内容：
```java
{
//分群来源 自定义分群是通过分群模块选择规则创建
"source": "自定义分群",
//创建时间
"createdTime": "2019-09-12 11:53:24",
//创建人
"createdUser": "管理员",
//最后更新时间
"updatedTime": "2019-09-12 11:53:29",
//分群规则内容
"content": {...}
}
```
### 2.4 接口调用示例
```java
curl -H "token:1b554f363d56238bf33a201620f2e9a9" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/cohort/2?needMore=false
```
## 3. 获取所有用户分群列表
获取某个项目下所有的用户分群列表。在 4.3.5 版本中新增。
### 3.1 接口地址
> 【GET】 /uba/api/cohort
### 3.2 请求参数示例
```java
//4.5.0 版本中才支持输入参数过滤
?needMore=true&status=success
```
> **认证参数**：接口必传token和appKey两个参数，详情见 [项目接口认证](../README.md)。
#### 3.2.1 入参说明
| 参数名称 | 类型 | 必填 | 说明 | 枚举 |
| -------- | ------- | -- | -------------------------------------------------------- | --------------------------------------------- |
| needMore | Boolean | N | <p>是否需要分群的详细信息。</p><p>备注：URL传参，默认为false</p> | <p>true</p><p>false</p> |
| status | String | N | <p>分群计算状态。成功、失败、计算中三种状态。</p><p>备注：URL传参，不传为获取所有状态分群。</p> | <p>success</p><p>failed</p><p>calculating</p> |
### 3.3 返回结果示例
```java
[
{
//【4.5.0中新增】分群id 在操作某个分群时使用
"id": 2,
//分群code 在查询用户详情时需要用到分群时都通过code来筛选
"code": "arkfq_2",
//分群名称，用户页面定义
"name": "test",
//动态分群 1为动态分群 每日凌晨计算一次
"dynamic": 1,
//当前分群的用户数
"userNumber": 992,
//【4.5.0中新增】分群状态 success：成功，failed：失败，calculating：计算中
"status": "success",
//【4.5.0中新增】分群最后一次计算时间
"calculatedTime": "2019-09-12 11:53:29",
//----------以下输出字段在needMore=true时才会返回------------//
//【4.5.0中新增】分群来源 自定义分群是通过分群模块选择规则创建
"source": "自定义分群",
//【4.5.0中新增】创建时间
"createdTime": "2019-09-12 11:53:24",
//【4.5.0中新增】创建人
"createdUser": "管理员",
//【4.5.0中新增】最后更新时间
"updatedTime": "2019-09-12 11:53:29",
//【4.5.0中新增】分群规则内容
"content": {}
},
{
"id": 5,
"code": "arkfq_5",
"name": "test",
//0为静态分群 在创建分群的时候计算一次
"dynamic": 0,
"userNumber": 22,
"status": "success",
"calculatedTime": "2019-09-15 13:53:29",
//分群来源，分析下钻分群通过个分析模块下钻创建，下钻的分群不返回规则内容
"source": "分析下钻分群",
"createdTime": "2019-09-15 13:53:24",
"createdUser": "管理员",
"updatedTime": "2019-09-15 13:53:29",
"content": ""
}
]
```
### 3.4 接口调用示例
```java
curl -H "token:1b554f363d56238bf33a201620f2e9a9" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/cohort?needMore=true&status=success
```
## 4. 重新计算单个分群
静态分群只在创建的时候计算一次，如果创建后有数据更新，可以调用接口重新计算一次分群。在 4.5.0 版本中新增。
### 4.1 接口地址
> 【POST】 /uba/api/cohort/{id}/recalculate
### 4.2 请求参数示例
无
> **认证参数**：接口必传token和appKey两个参数，详情见 [项目接口认证](../README.md)。
#### 4.2.1 入参说明
| 参数名称 | 类型 | 必填 | 说明 | 枚举 |
| ---- | ---- | -- | ---- | -- |
| id | Long | Y | 分群ID | |
### 4.3 返回结果示例
```java
{
//人群ID
"id": 2,
//分群状态
"status": "calculating"
}
```
### 4.4 接口调用示例
```java
curl -H "token:1b554f363d56238bf33a201620f2e9a9" -H "appKey:31abd9593e9983ec" -X POST http://127.0.0.1:4005/uba/api/cohort/2/recalculate
```
## 5. 删除单个分群
当前用户分群规则是只能删除自己创建的分群，如果API不带loginUser参数只能删除通过API创建并且未带loginUser的分群。如果带loginUser参数，就能删除对应用户创建的分群。在 4.5.0 版本中新增。
### 5.1 接口地址
> 【DELETE】 /uba/api/cohort/{id}
### 5.2 请求参数示例
无
> **认证参数**：接口必传token和appKey两个参数，详情见 [项目接口认证](../README.md)。
>
> **操作用户**：通过API默认只能删除属于API的分群，如果需要删除某个用户的分群，需要在URL上带loginUser参数，详情见 [操作用户](../#51-cao-zuo-yong-hu)。
#### 5.2.1 入参说明
| 参数名称 | 类型 | 必填 | 说明 | 枚举 |
| ---- | ---- | -- | ---- | -- |
| id | Long | Y | 分群ID | |
### 5.3 返回结果示例
```java
{
//返回success说明接口调用成功
"success":0
}
```
### 5.4 接口调用示例
```java
curl -H "token:1b554f363d56238bf33a201620f2e9a9" -H "appKey:31abd9593e9983ec" -X DELETE http://127.0.0.1:4005/uba/api/cohort/2
```
## 6. 上传用户属性创建分群
通过上传某一个用户属性的数据文件，用文件中的数据作为对应属性的条件去筛选，将符合条件的用户保存为为一个用户群。在 5.2 版本中新增。
### **6.1 接口地址**
> 【POST】 /uba/api/cohort/byfile
### 6.2 请求参数示例\*\*
form-data传参
| 参数名称 | 类型 | 必填 | 说明 |
| -------- | ------ | -- | ------------------------------------------------ |
| name | String | Y | 分群名称，不能重复 |
| file | file | Y | <p>上传的文件，只支持excel格式，</p><p>输入一列值，文件大小不能超过10M</p> |
| property | String | N | 文件中值对应的属性，默认为xwho，只支持字符串类型的用户属性 |
> **认证参数**：接口必传token和appKey两个参数，详情见 [项目接口认证](../README.md)。
>
> **操作用户**：通过API创建的分群默认为API所有，不属于任何用户，如果想让某个用户在页面上对此分群进行操作，需要在URL上带loginUser参数，详情见 [操作用户](../#51-cao-zuo-yong-hu)。
### 6.3 返回结果示例
```
{
"id": 2,
"code": "arkfq_2",
"name": "广告投放成功用户",
"dynamic": 0,
"createTime": "2019-09-12 11:53:24"
}
```
### 6.4 接口调用示例
```java
public void createCohortByFile() throws IOException {
CloseableHttpClient client = HttpClients.createDefault();
HttpPost httpPost = new HttpPost(API_HOST + "/uba/api/cohort/byfile");
httpPost.setHeader("appKey", APP_KEY);
httpPost.setHeader("token", APP_TOKEN);
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
//设置请求的编码格式
builder.setContentType(ContentType.MULTIPART_FORM_DATA);
//输入分群名称
StringBody nameBody = new StringBody("99活动激活", ContentType.create("text/plain", Consts.UTF_8));
builder.addPart("name", nameBody);
//对应属性值
builder.addBinaryBody("file", new File("/Users/yuan/Documents/data/ark/file/99激活用户ID.xlsx"));
//指定属性列
builder.addTextBody("property", "xwho");
httpPost.setEntity(builder.build());
//设置超时时间
RequestConfig reqConfig = RequestConfig.custom().setSocketTimeout(30*60*1000).setConnectTimeout(60*1000).build();
httpPost.setConfig(reqConfig);
CloseableHttpResponse response = client.execute(httpPost);
//获取响应状态
int httpStatus = response.getStatusLine().getStatusCode();
//获取响应内容
HttpEntity responseEntity = response.getEntity();
String reponseContent = EntityUtils.toString(responseEntity);
EntityUtils.consume(responseEntity);
}
```
- 产品简介
- 快速上手
- 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 许可
- 产品试用及采购
- 参与贡献