跳到主要内容

分布分析模型 API

最近更新 2026/10/03

调用方法请参见Open API文档中的调用方法描述。

可阅读使用手册中 分布分析 了解使用场景。

1. 分布分析查询​

接口URL

/open/distribution-analyze?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数​

{
"eventView":{
"endTime":"2021-10-05 23:59:59",
"groupBy":[
{
"columnDesc":"学历",
"columnName":"education",
"propertyRange":"",
"specifiedClusterDate":"2022-01-24",
"tableType":"user"
},
{
"columnDesc":"城市",
"columnName":"city",
"propertyRange":"",
"specifiedClusterDate":"2022-01-24",
"tableType":"user"
}],
"recentDay":"114-115",
"startTime":"2021-10-04 00:00:00",
"taIdMeasureVo":{
"columnDesc":"用户唯一ID",
"columnName":"#user_id",
"tableType":"event"
},
"timeParticleSize":"day"
},
"events":[
{
"customEvent":"activity_attend.TIMES",
"customFilters":[
],
"eventName":"自定义指标",
"eventNameDisplay":"",
"filts":[
{
"columnDesc":"城市",
"columnName":"city",
"comparator":"equal",
"filterType":"SIMPLE",
"ftv":[
"北京市",
"上海市",
"广州市",
"深圳市"],
"specifiedClusterDate":"2022-01-27",
"tableType":"user",
"timeUnit":""
}],
"formulation":{
"formulationDeps":[
{
"event":{
"eventDesc":"参加活动",
"eventName":"activity_attend"
}
}]
},
"intervalType":"user_defined",
"quota":"",
"quotaIntervalArr":[
500],
"relation":"and",
"type":"customized"
},
{
"analysis":"TOTAL_TIMES",
"analysisDesc":"总次数",
"eventName":"payment",
"eventNameDisplay":"",
"filts":[
],
"intervalType":"def",
"quota":"",
"relation":"and",
"type":"normal"
}],
"projectId":377,
"limit": 2,
"timeoutSeconds": 10,
"useCache": true,
"zoneOffset": 10
}

请求参数说明​

$$参数名示例值参数类型是否必填参数描述
eventView-Object是指标公共属性部分
eventView.endTime2021-10-05 23:59:59String否结束时间(格式:yyyy-MM-dd HH:mm:ss),相对时间为空时有效
eventView.groupBy-List否分组属性,可以有零个或者多个
eventView.groupBy.columnDesc学历String否字段显示名
eventView.groupBy.columnNameeducationString是字段名
eventView.groupBy.propertyRangeString否自定义属性区间
eventView.groupBy.specifiedClusterDate2022-01-24String否指定对应日期的标签历史版本
eventView.groupBy.tableTypeuserString是表类型枚举值
eventView.recentDay114-115String否相对时间(此项不可与起始时间和结束时间同时为空)
eventView.startTime2021-10-04 00:00:00String否起始时间(格式:yyyy-MM-dd HH:mm:ss),相对时间为空时有效
eventView.taIdMeasureVo-Object否分析主体配置
eventView.taIdMeasureVo.columnDesc用户唯一IDString否字段显示名
eventView.taIdMeasureVo.columnName#user_idString是字段名
eventView.taIdMeasureVo.tableTypeeventString是表类型枚举值
eventView.timeParticleSizeday

String

是

分析的时间单位

  • day:按天
  • week:按周
  • month:按月
  • total:总计
events-List是事件指标列表
events.analysisTOTAL_TIMESString否分析角度,具体见 分布聚合类型枚举值
events.analysisDesc总次数String否分析角度描述(显示名)
events.customEventactivity_attend.TIMESString否

公式表达式,由分析项或数值常量的加减乘除构成。分析项有两种形式: eventName.columnName.analysis 或 eventName.analysis。

公式中含分析指标的时候用固定前缀+指标名称的方式,比如:

$metric.metricName/eventName.columnName.analysis或者

$metric.metricName1/$metric.metricName2

events.customFilters[]List否公式表达式过滤项列表
events.eventNameloginString是指标事件名称,可以使用 anyEvent 表示任意事件
events.eventNameDisplayString否自定义指标显示名
events.filts-List否条件筛选列表
events.filts.columnDesc城市String否字段显示名
events.filts.columnNamecityString是字段名称
events.filts.comparatorequalString是参考: 模型查询API的筛选表达式
events.filts.filterTypeSIMPLEString否过滤模式,SIMPLE:简单,COMPOUND:复合
events.filts.ftv["北京市"]List否用于属性比较边界的字面常量
events.filts.specifiedClusterDate2022-01-27String否指定对应日期的标签历史版本
events.filts.tableTypeuserString是表类型枚举值
events.filts.timeUnitString否过滤时间单位
events.intervalTypeuser_definedString否

区间间隔类型

  • discrete:离散数字
  • def:默认区间
  • user_defined:用户自定义
events.quotaString否指标属性
events.quotaIntervalArr[500]List否自定义指标区间
events.relationandString否逻辑关系,and:逻辑与,or:逻辑或
events.typenormalString是

指标类型,

  • normal:普通分析
  • customized:自定义公式
projectId0Integer是项目ID
limit2Integer否每分析对象的分组数上限,可选参数,默认为1000,最大为10000
timeoutSeconds10Integer否请求超时参数,超时则取消查询任务
useCachetrueBoolean是true为使用缓存
zoneOffset10Integer否时区

成功响应示例​

{
"data": {
"distribution_interval": [
",500",
"500,"
],
"result_generate_time": "2022-01-27 11:25:44",
"x": [
"2021-10-04",
"2021-10-05"
],
"y": {
"2021-10-04": [
{
"groupCols": [
"总体",
"总体"
],
"isTotal": 1,
"meanwhileValues": [
"28249",
"-"
],
"totalMeanwhileValue": "28249",
"totalUserNum": 1722,
"values": [
1722,
0
]
},
{
"groupCols": [
"其他",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"3842",
"-"
],
"totalMeanwhileValue": "3842",
"totalUserNum": 235,
"values": [
235,
0
]
},
{
"groupCols": [
"大专",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"2421",
"-"
],
"totalMeanwhileValue": "2421",
"totalUserNum": 154,
"values": [
154,
0
]
},
{
"groupCols": [
"其他",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"2518",
"-"
],
"totalMeanwhileValue": "2518",
"totalUserNum": 151,
"values": [
151,
0
]
},
{
"groupCols": [
"其他",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"2355",
"-"
],
"totalMeanwhileValue": "2355",
"totalUserNum": 142,
"values": [
142,
0
]
},
{
"groupCols": [
"其他",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"1906",
"-"
],
"totalMeanwhileValue": "1906",
"totalUserNum": 116,
"values": [
116,
0
]
},
{
"groupCols": [
"大专",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"1738",
"-"
],
"totalMeanwhileValue": "1738",
"totalUserNum": 107,
"values": [
107,
0
]
},
{
"groupCols": [
"本科",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"1720",
"-"
],
"totalMeanwhileValue": "1720",
"totalUserNum": 106,
"values": [
106,
0
]
},
{
"groupCols": [
"大专",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"1658",
"-"
],
"totalMeanwhileValue": "1658",
"totalUserNum": 101,
"values": [
101,
0
]
},
{
"groupCols": [
"本科",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"1595",
"-"
],
"totalMeanwhileValue": "1595",
"totalUserNum": 96,
"values": [
96,
0
]
},
{
"groupCols": [
"研究生",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"1315",
"-"
],
"totalMeanwhileValue": "1315",
"totalUserNum": 78,
"values": [
78,
0
]
},
{
"groupCols": [
"本科",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"1276",
"-"
],
"totalMeanwhileValue": "1276",
"totalUserNum": 75,
"values": [
75,
0
]
},
{
"groupCols": [
"大专",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"1207",
"-"
],
"totalMeanwhileValue": "1207",
"totalUserNum": 75,
"values": [
75,
0
]
},
{
"groupCols": [
"研究生",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"1032",
"-"
],
"totalMeanwhileValue": "1032",
"totalUserNum": 63,
"values": [
63,
0
]
},
{
"groupCols": [
"本科",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"796",
"-"
],
"totalMeanwhileValue": "796",
"totalUserNum": 49,
"values": [
49,
0
]
},
{
"groupCols": [
"研究生",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"678",
"-"
],
"totalMeanwhileValue": "678",
"totalUserNum": 42,
"values": [
42,
0
]
},
{
"groupCols": [
"研究生",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"674",
"-"
],
"totalMeanwhileValue": "674",
"totalUserNum": 38,
"values": [
38,
0
]
},
{
"groupCols": [
"博士",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"514",
"-"
],
"totalMeanwhileValue": "514",
"totalUserNum": 33,
"values": [
33,
0
]
},
{
"groupCols": [
"博士",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"361",
"-"
],
"totalMeanwhileValue": "361",
"totalUserNum": 21,
"values": [
21,
0
]
},
{
"groupCols": [
"博士",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"327",
"-"
],
"totalMeanwhileValue": "327",
"totalUserNum": 20,
"values": [
20,
0
]
},
{
"groupCols": [
"博士",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"316",
"-"
],
"totalMeanwhileValue": "316",
"totalUserNum": 20,
"values": [
20,
0
]
}
],
"2021-10-05": [
{
"groupCols": [
"总体",
"总体"
],
"isTotal": 1,
"meanwhileValues": [
"24907",
"-"
],
"totalMeanwhileValue": "24907",
"totalUserNum": 1503,
"values": [
1503,
0
]
},
{
"groupCols": [
"其他",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"3535",
"-"
],
"totalMeanwhileValue": "3535",
"totalUserNum": 221,
"values": [
221,
0
]
},
{
"groupCols": [
"其他",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"2833",
"-"
],
"totalMeanwhileValue": "2833",
"totalUserNum": 162,
"values": [
162,
0
]
},
{
"groupCols": [
"大专",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"2183",
"-"
],
"totalMeanwhileValue": "2183",
"totalUserNum": 130,
"values": [
130,
0
]
},
{
"groupCols": [
"其他",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"1946",
"-"
],
"totalMeanwhileValue": "1946",
"totalUserNum": 116,
"values": [
116,
0
]
},
{
"groupCols": [
"其他",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"1743",
"-"
],
"totalMeanwhileValue": "1743",
"totalUserNum": 109,
"values": [
109,
0
]
},
{
"groupCols": [
"本科",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"1753",
"-"
],
"totalMeanwhileValue": "1753",
"totalUserNum": 107,
"values": [
107,
0
]
},
{
"groupCols": [
"大专",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"1606",
"-"
],
"totalMeanwhileValue": "1606",
"totalUserNum": 92,
"values": [
92,
0
]
},
{
"groupCols": [
"本科",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"1421",
"-"
],
"totalMeanwhileValue": "1421",
"totalUserNum": 81,
"values": [
81,
0
]
},
{
"groupCols": [
"本科",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"1093",
"-"
],
"totalMeanwhileValue": "1093",
"totalUserNum": 68,
"values": [
68,
0
]
},
{
"groupCols": [
"研究生",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"1037",
"-"
],
"totalMeanwhileValue": "1037",
"totalUserNum": 65,
"values": [
65,
0
]
},
{
"groupCols": [
"大专",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"947",
"-"
],
"totalMeanwhileValue": "947",
"totalUserNum": 59,
"values": [
59,
0
]
},
{
"groupCols": [
"大专",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"963",
"-"
],
"totalMeanwhileValue": "963",
"totalUserNum": 58,
"values": [
58,
0
]
},
{
"groupCols": [
"研究生",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"698",
"-"
],
"totalMeanwhileValue": "698",
"totalUserNum": 42,
"values": [
42,
0
]
},
{
"groupCols": [
"本科",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"608",
"-"
],
"totalMeanwhileValue": "608",
"totalUserNum": 39,
"values": [
39,
0
]
},
{
"groupCols": [
"研究生",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"560",
"-"
],
"totalMeanwhileValue": "560",
"totalUserNum": 37,
"values": [
37,
0
]
},
{
"groupCols": [
"研究生",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"553",
"-"
],
"totalMeanwhileValue": "553",
"totalUserNum": 31,
"values": [
31,
0
]
},
{
"groupCols": [
"博士",
"北京市"
],
"isTotal": 0,
"meanwhileValues": [
"478",
"-"
],
"totalMeanwhileValue": "478",
"totalUserNum": 29,
"values": [
29,
0
]
},
{
"groupCols": [
"博士",
"广州市"
],
"isTotal": 0,
"meanwhileValues": [
"353",
"-"
],
"totalMeanwhileValue": "353",
"totalUserNum": 22,
"values": [
22,
0
]
},
{
"groupCols": [
"博士",
"上海市"
],
"isTotal": 0,
"meanwhileValues": [
"339",
"-"
],
"totalMeanwhileValue": "339",
"totalUserNum": 19,
"values": [
19,
0
]
},
{
"groupCols": [
"博士",
"深圳市"
],
"isTotal": 0,
"meanwhileValues": [
"258",
"-"
],
"totalMeanwhileValue": "258",
"totalUserNum": 16,
"values": [
16,
0
]
}
]
}
},
"return_code": 0,
"return_message": "success"
}

响应参数说明​

$$参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息
data-Object返回结果
data. distribution_interval[",500","500,"]List分布间隔
data.result_generate_time2022-01-27 11:25:44String结果生成时间
data.x["2021-10-04"]Listx轴信息
data.y-Listy轴信息
data.y.{dateMap}"2021-10-04": {dateData}Map按日期粒度为key的map
data.y.{dateMap}.{key}2021-10-04String日期字符串
data.y.{dateMap}.{value}-List表格数据
data.y.{dateMap}.{value}.isTotalfalseBoolean是否合计
data.y.{dateMap}.{value}.values-List主聚合值
data.y.{dateMap}.{value}.meanwhileValues-List同时展示聚合值

错误响应示例

{
"return_code": -1008,
"return_message": "参数(token)为空"
}
参数名示例值参数类型参数描述
return_code-1008Integer返回码
return_message参数(token)为空String返回信息

2. 分布分析全量下载​

接口URL

/open/streaming-download/distribution-analyze?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数​

{
"eventView": {
"endTime": "2022-03-07 17:36:54",
"groupBy": [
{
"columnDesc": "channel",
"columnName": "channel",
"propertyRange": "",
"specifiedClusterDate": "2022-03-08",
"tableType": "event"
}
],
"recentDay": "1-7",
"startTime": "2022-03-01 17:36:54",
"taIdMeasureVo": {
"columnDesc": "用户唯一ID",
"columnName": "#user_id",
"tableType": "event"
},
"timeParticleSize": "day"
},
"events": [
{
"analysis": "TIMES",
"analysisDesc": "次数",
"eventName": "LogOut",
"eventNameDisplay": "",
"filts": [],
"intervalType": "def",
"quota": "",
"relation": "and",
"type": "normal"
}
],
"projectId": 319,
"interval": "['1']",
"zoneOffset": 10
}

请求参数说明​

$$参数名示例值参数类型是否必填参数描述
eventView-Object是参数内容与分布分析查询接口一致
events-List是参数内容与分布分析查询接口一致
projectId0Integer是项目ID
interval['1','2']String是全量间隔
meanwhileOnlyBoolean否是否只下载同时展示,default:false
zoneOffset10Integer否时区
提示

请求参数可以直接从AE系统 分布分析页面导出,并添加interval等其他参数,该参数可以从全量下载页面抓取

响应​

同AE系统事件分析全量下载

3. 分布分析用户列表​

接口URL

/open/distribution-user-list?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数​

{
"projectId": 0,
"eventView": {
"startTime": "2019-10-28 00:00:00",
"endTime": "2019-11-26 00:00:00",
"recentDay": "D31",
"timeParticleSize": "week",
"groupBy": [
{
"columnName": "#province",
"tableType": "event"
}
]
},
"events": [{
"analysis": "TIMES",
"eventName": "consume_item",
"intervalType": "def",
"quota": "",
"relation": "and",
"filts": [
{
"columnName": "#os",
"comparator": "equal",
"ftv": [
"android"
],
"tableType": "event"
}
]
}],
"interval": "10,20",
"sliceDate": "2019-11-18",
"sliceGroupVal": ["北京市"],
"timeoutSeconds": 10,
"zoneOffset": 10
}

请求参数说明​

$$参数名示例值参数类型是否必填参数描述
projectId0String是参数描述
eventView-Object是参数内容与分布分析查询接口一致
eventsList是参数内容与分布分析查询接口一致
interval10,20String否哪个区间进行下钻
groupBit0Integer否是否合计列下钻,1是合计列,其他非合计列
sliceDate"2019-11-18"String否哪个日期进行下钻
sliceGroupVal["北京市"]List是哪个分组进行下钻
timeoutSeconds10Integer否请求超时参数,超时则取消查询任务
zoneOffset10Integer否时区

成功响应示例​

{
"data": {
"datalist": [
{
"#account_id": "h7784497",
"#distinct_id": "h14456917",
"user_level": 13,
"register_time": "2019-11-24 21:52:38",
"diamond_num": 1201,
"latest_login_time": "2019-11-24 23:35:49",
"channel": "百度手机助手",
"#user_id": 3336217
},
{
"#account_id": "h6201359",
"#distinct_id": "h11516759",
"user_level": 68,
"register_time": "2019-06-23 09:25:18",
"diamond_num": 1686,
"first_recharge_time": "2019-06-23 09:25:38",
"latest_login_time": "2019-11-18 23:01:49",
"channel": "华为应用市场",
"#user_id": 2657759
},
{
"#account_id": "g4102426",
"#distinct_id": "g7618786",
"user_level": 47,
"register_time": "2019-07-29 13:58:23",
"diamond_num": 1,
"first_recharge_time": "2019-07-29 15:42:20",
"latest_login_time": "2019-11-24 16:04:03",
"channel": "应用宝",
"#user_id": 1758186
}
],
"columMeta": {
"#account_id": "账户ID",
"#distinct_id": "访客ID",
"user_level": "用户等级",
"register_time": "注册时间",
"diamond_num": "当前拥有钻石数",
"first_recharge_time": "首次充值时间",
"latest_login_time": "最后登录时间",
"channel": "渠道"
}
},
"return_code": 0,
"return_message": "success"
}

响应参数说明​

$$参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息
data-Object返回结果
data.datalist-List<Map>用户信息
data.columMeta-Map字段含义映射

错误响应示例

{
"return_code": -1008,
"return_message": "参数(token)为空"
}
参数名示例值参数类型参数描述
return_code-1008Integer返回码
return_message参数(token)为空String返回信息

4. 分布分析用户列表下载​

接口URL

/open/streaming-download/distribution-user-list?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数​

{
"eventView": {
"endTime": "2022-03-07 17:36:54",
"groupBy": [
{
"columnDesc": "channel",
"columnName": "channel",
"propertyRange": "",
"specifiedClusterDate": "2022-03-08",
"tableType": "event"
}
],
"recentDay": "1-7",
"startTime": "2022-03-01 17:36:54",
"taIdMeasureVo": {
"columnDesc": "用户唯一ID",
"columnName": "#user_id",
"tableType": "event"
},
"timeParticleSize": "day"
},
"events": [
{
"analysis": "TIMES",
"analysisDesc": "次数",
"eventName": "LogOut",
"eventNameDisplay": "",
"filts": [],
"intervalType": "def",
"quota": "",
"relation": "and",
"type": "normal"
}
],
"projectId": 319,
"groupBit": 0,
"sliceDate": "2022-03-01",
"sliceGroupVal": [
"VIVO应用商城"
],
"selectedColumns": [
"#account_id",
"#distinct_id"
],
"zoneOffset": 10
}

请求参数说明​

$$参数名示例值参数类型是否必填参数描述
projectId0String是参数描述
eventView-Object是参数内容与分布分析查询接口一致
events-List是参数内容与分布分析查询接口一致
interval10,20String是哪个区间进行下钻
groupBit0Integer否是否合计列下钻,1是合计列,其他非合计列
sliceDate"2019-11-18"String否哪个日期进行下钻
sliceGroupVal["北京市"]List是哪个分组进行下钻
selectedColumns["#account_id"]array否被下载的列
zoneOffset10Integer否时区

响应​

同AE系统分布分析用户列表下载

分布分析通用枚举​

分布聚合类型枚举值​

值描述是否需要属性
TIMES次数否
NUMBER_OF_DAYS天数否
NUMBER_OF_HOURS小时数否
SUM数值总和是
AVG数值平均值是
MAX数值最大值是
MIN数值最小值是
DISTINCT去重数是
TRUE为真数是
FALSE为假数是
IS_NOT_EMPTY不为空数是
IS_EMPTY为空数是
ARRAY_DISTINCT列表整体去重数是
ARRAY_SET_DISTINCT元素集合去重数是
ARRAY_ITEM_DISTINCT列表元素去重数是
MEDIAN中位数是
这篇文档对你有帮助吗?