manuallatestProduct Manual / Distribution Analysis model API
Distribution Analysis model API
For how to call the API, see the calling method described in the Open API document.
To learn about use cases, read Distribution Analysis in the user guide.
1. Distribution Analysis query
Endpoint URL
/open/distribution-analyze?token=xxx
Request method
POST
Content-Type
application/json
Request query parameters
| Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| token | xxx | String | Yes | Query key |
Request body parameters
{
"eventView":{
"endTime":"2021-10-05 23:59:59",
"groupBy":[
{
"columnDesc":"Education",
"columnName":"education",
"propertyRange":"",
"specifiedClusterDate":"2022-01-24",
"tableType":"user"
},
{
"columnDesc":"City",
"columnName":"city",
"propertyRange":"",
"specifiedClusterDate":"2022-01-24",
"tableType":"user"
}],
"recentDay":"114-115",
"startTime":"2021-10-04 00:00:00",
"taIdMeasureVo":{
"columnDesc":"User Unique ID",
"columnName":"#user_id",
"tableType":"event"
},
"timeParticleSize":"day"
},
"events":[
{
"customEvent":"activity_attend.TIMES",
"customFilters":[
],
"eventName":"Custom Metric",
"eventNameDisplay":"",
"filts":[
{
"columnDesc":"City",
"columnName":"city",
"comparator":"equal",
"filterType":"SIMPLE",
"ftv":[
"Beijing",
"Shanghai",
"Guangzhou",
"Shenzhen"],
"specifiedClusterDate":"2022-01-27",
"tableType":"user",
"timeUnit":""
}],
"formulation":{
"formulationDeps":[
{
"event":{
"eventDesc":"Attend Activity",
"eventName":"activity_attend"
}
}]
},
"intervalType":"user_defined",
"quota":"",
"quotaIntervalArr":[
500],
"relation":"and",
"type":"customized"
},
{
"analysis":"TOTAL_TIMES",
"analysisDesc":"Event total",
"eventName":"payment",
"eventNameDisplay":"",
"filts":[
],
"intervalType":"def",
"quota":"",
"relation":"and",
"type":"normal"
}],
"projectId":377,
"limit": 2,
"timeoutSeconds": 10,
"useCache": true,
"zoneOffset": 10
}
Request parameters
| $$Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| eventView | - | Object | Yes | Common properties of the metrics |
| eventView.endTime | 2021-10-05 23:59:59 | String | No | End time (format: yyyy-MM-dd HH:mm:ss). Takes effect when the relative time is empty |
| eventView.groupBy | - | List | No | Group-by properties. There can be zero or more |
| eventView.groupBy.columnDesc | Education | String | No | Field display name |
| eventView.groupBy.columnName | education | String | Yes | Field name |
| eventView.groupBy.propertyRange | String | No | Custom property range | |
| eventView.groupBy.specifiedClusterDate | 2022-01-24 | String | No | Uses the historical version of the tag for the specified date |
| eventView.groupBy.tableType | user | String | Yes | Table type enum values |
| eventView.recentDay | 114-115 | String | No | Relative time (this item, the start time, and the end time can't all be empty) |
| eventView.startTime | 2021-10-04 00:00:00 | String | No | Start time (format: yyyy-MM-dd HH:mm:ss). Takes effect when the relative time is empty |
| eventView.taIdMeasureVo | - | Object | No | Analysis entity configuration |
| eventView.taIdMeasureVo.columnDesc | User Unique ID | String | No | Field display name |
| eventView.taIdMeasureVo.columnName | #user_id | String | Yes | Field name |
| eventView.taIdMeasureVo.tableType | event | String | Yes | Table type enum values |
| eventView.timeParticleSize | day | String | Yes | Time unit of the analysis
|
| events | - | List | Yes | List of event metrics |
| events.analysis | TOTAL_TIMES | String | No | Analysis type. For details, see Distribution aggregation type enum values |
| events.analysisDesc | Event total | String | No | Description of the analysis type (display name) |
| events.customEvent | activity_attend.TIMES | String | No | Formula expression, made up of analysis items or numeric constants combined by addition, subtraction, multiplication, and division. Analysis items take one of two forms: eventName.columnName.analysis or eventName.analysis. When the formula contains analysis metrics, use a fixed prefix plus the metric name, for example: $metric.metricName/eventName.columnName.analysis or $metric.metricName1/$metric.metricName2 |
| events.customFilters | [] | List | No | List of filters for the formula expression |
| events.eventName | login | String | Yes | Event name of the metric. You can use anyEvent to represent any event |
| events.eventNameDisplay | String | No | Display name of the custom metric | |
| events.filts | - | List | No | List of filter conditions |
| events.filts.columnDesc | City | String | No | Field display name |
| events.filts.columnName | city | String | Yes | Field name |
| events.filts.comparator | equal | String | Yes | See Filter expressions in the Query API |
| events.filts.filterType | SIMPLE | String | No | Filter mode. SIMPLE: simple, COMPOUND: compound |
| events.filts.ftv | ["Beijing"] | List | No | Literal constants used as boundaries for property comparison |
| events.filts.specifiedClusterDate | 2022-01-27 | String | No | Uses the historical version of the tag for the specified date |
| events.filts.tableType | user | String | Yes | Table type enum values |
| events.filts.timeUnit | String | No | Time unit of the filter | |
| events.intervalType | user_defined | String | No | Interval type
|
| events.quota | String | No | Metric property | |
| events.quotaIntervalArr | [500] | List | No | Custom metric intervals |
| events.relation | and | String | No | Logical relation. and: logical AND, or: logical OR |
| events.type | normal | String | Yes | Metric type:
|
| projectId | 0 | Integer | Yes | Project ID |
| limit | 2 | Integer | No | Maximum number of groups per analysis object. Optional. Defaults to 1000, with a maximum of 10000 |
| timeoutSeconds | 10 | Integer | No | Request timeout. The query task is canceled when it times out |
| useCache | true | Boolean | Yes | true means the cache is used |
| zoneOffset | 10 | Integer | No | Time zone |
Success response example
{
"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": [
"Overall",
"Overall"
],
"isTotal": 1,
"meanwhileValues": [
"28249",
"-"
],
"totalMeanwhileValue": "28249",
"totalUserNum": 1722,
"values": [
1722,
0
]
},
{
"groupCols": [
"Other",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"3842",
"-"
],
"totalMeanwhileValue": "3842",
"totalUserNum": 235,
"values": [
235,
0
]
},
{
"groupCols": [
"Associate Degree",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"2421",
"-"
],
"totalMeanwhileValue": "2421",
"totalUserNum": 154,
"values": [
154,
0
]
},
{
"groupCols": [
"Other",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"2518",
"-"
],
"totalMeanwhileValue": "2518",
"totalUserNum": 151,
"values": [
151,
0
]
},
{
"groupCols": [
"Other",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"2355",
"-"
],
"totalMeanwhileValue": "2355",
"totalUserNum": 142,
"values": [
142,
0
]
},
{
"groupCols": [
"Other",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"1906",
"-"
],
"totalMeanwhileValue": "1906",
"totalUserNum": 116,
"values": [
116,
0
]
},
{
"groupCols": [
"Associate Degree",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"1738",
"-"
],
"totalMeanwhileValue": "1738",
"totalUserNum": 107,
"values": [
107,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"1720",
"-"
],
"totalMeanwhileValue": "1720",
"totalUserNum": 106,
"values": [
106,
0
]
},
{
"groupCols": [
"Associate Degree",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"1658",
"-"
],
"totalMeanwhileValue": "1658",
"totalUserNum": 101,
"values": [
101,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"1595",
"-"
],
"totalMeanwhileValue": "1595",
"totalUserNum": 96,
"values": [
96,
0
]
},
{
"groupCols": [
"Master's Degree",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"1315",
"-"
],
"totalMeanwhileValue": "1315",
"totalUserNum": 78,
"values": [
78,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"1276",
"-"
],
"totalMeanwhileValue": "1276",
"totalUserNum": 75,
"values": [
75,
0
]
},
{
"groupCols": [
"Associate Degree",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"1207",
"-"
],
"totalMeanwhileValue": "1207",
"totalUserNum": 75,
"values": [
75,
0
]
},
{
"groupCols": [
"Master's Degree",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"1032",
"-"
],
"totalMeanwhileValue": "1032",
"totalUserNum": 63,
"values": [
63,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"796",
"-"
],
"totalMeanwhileValue": "796",
"totalUserNum": 49,
"values": [
49,
0
]
},
{
"groupCols": [
"Master's Degree",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"678",
"-"
],
"totalMeanwhileValue": "678",
"totalUserNum": 42,
"values": [
42,
0
]
},
{
"groupCols": [
"Master's Degree",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"674",
"-"
],
"totalMeanwhileValue": "674",
"totalUserNum": 38,
"values": [
38,
0
]
},
{
"groupCols": [
"Doctorate",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"514",
"-"
],
"totalMeanwhileValue": "514",
"totalUserNum": 33,
"values": [
33,
0
]
},
{
"groupCols": [
"Doctorate",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"361",
"-"
],
"totalMeanwhileValue": "361",
"totalUserNum": 21,
"values": [
21,
0
]
},
{
"groupCols": [
"Doctorate",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"327",
"-"
],
"totalMeanwhileValue": "327",
"totalUserNum": 20,
"values": [
20,
0
]
},
{
"groupCols": [
"Doctorate",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"316",
"-"
],
"totalMeanwhileValue": "316",
"totalUserNum": 20,
"values": [
20,
0
]
}
],
"2021-10-05": [
{
"groupCols": [
"Overall",
"Overall"
],
"isTotal": 1,
"meanwhileValues": [
"24907",
"-"
],
"totalMeanwhileValue": "24907",
"totalUserNum": 1503,
"values": [
1503,
0
]
},
{
"groupCols": [
"Other",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"3535",
"-"
],
"totalMeanwhileValue": "3535",
"totalUserNum": 221,
"values": [
221,
0
]
},
{
"groupCols": [
"Other",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"2833",
"-"
],
"totalMeanwhileValue": "2833",
"totalUserNum": 162,
"values": [
162,
0
]
},
{
"groupCols": [
"Associate Degree",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"2183",
"-"
],
"totalMeanwhileValue": "2183",
"totalUserNum": 130,
"values": [
130,
0
]
},
{
"groupCols": [
"Other",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"1946",
"-"
],
"totalMeanwhileValue": "1946",
"totalUserNum": 116,
"values": [
116,
0
]
},
{
"groupCols": [
"Other",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"1743",
"-"
],
"totalMeanwhileValue": "1743",
"totalUserNum": 109,
"values": [
109,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"1753",
"-"
],
"totalMeanwhileValue": "1753",
"totalUserNum": 107,
"values": [
107,
0
]
},
{
"groupCols": [
"Associate Degree",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"1606",
"-"
],
"totalMeanwhileValue": "1606",
"totalUserNum": 92,
"values": [
92,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"1421",
"-"
],
"totalMeanwhileValue": "1421",
"totalUserNum": 81,
"values": [
81,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"1093",
"-"
],
"totalMeanwhileValue": "1093",
"totalUserNum": 68,
"values": [
68,
0
]
},
{
"groupCols": [
"Master's Degree",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"1037",
"-"
],
"totalMeanwhileValue": "1037",
"totalUserNum": 65,
"values": [
65,
0
]
},
{
"groupCols": [
"Associate Degree",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"947",
"-"
],
"totalMeanwhileValue": "947",
"totalUserNum": 59,
"values": [
59,
0
]
},
{
"groupCols": [
"Associate Degree",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"963",
"-"
],
"totalMeanwhileValue": "963",
"totalUserNum": 58,
"values": [
58,
0
]
},
{
"groupCols": [
"Master's Degree",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"698",
"-"
],
"totalMeanwhileValue": "698",
"totalUserNum": 42,
"values": [
42,
0
]
},
{
"groupCols": [
"Bachelor's Degree",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"608",
"-"
],
"totalMeanwhileValue": "608",
"totalUserNum": 39,
"values": [
39,
0
]
},
{
"groupCols": [
"Master's Degree",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"560",
"-"
],
"totalMeanwhileValue": "560",
"totalUserNum": 37,
"values": [
37,
0
]
},
{
"groupCols": [
"Master's Degree",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"553",
"-"
],
"totalMeanwhileValue": "553",
"totalUserNum": 31,
"values": [
31,
0
]
},
{
"groupCols": [
"Doctorate",
"Beijing"
],
"isTotal": 0,
"meanwhileValues": [
"478",
"-"
],
"totalMeanwhileValue": "478",
"totalUserNum": 29,
"values": [
29,
0
]
},
{
"groupCols": [
"Doctorate",
"Guangzhou"
],
"isTotal": 0,
"meanwhileValues": [
"353",
"-"
],
"totalMeanwhileValue": "353",
"totalUserNum": 22,
"values": [
22,
0
]
},
{
"groupCols": [
"Doctorate",
"Shanghai"
],
"isTotal": 0,
"meanwhileValues": [
"339",
"-"
],
"totalMeanwhileValue": "339",
"totalUserNum": 19,
"values": [
19,
0
]
},
{
"groupCols": [
"Doctorate",
"Shenzhen"
],
"isTotal": 0,
"meanwhileValues": [
"258",
"-"
],
"totalMeanwhileValue": "258",
"totalUserNum": 16,
"values": [
16,
0
]
}
]
}
},
"return_code": 0,
"return_message": "success"
}
Response parameters
| $$Parameter name | Example value | Parameter type | Description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return message |
| data | - | Object | Returned result |
| data. distribution_interval | [",500","500,"] | List | Distribution intervals |
| data.result_generate_time | 2022-01-27 11:25:44 | String | Result generation time |
| data.x | ["2021-10-04"] | List | X-axis information |
| data.y | - | List | Y-axis information |
| data.y.{dateMap} | "2021-10-04": {dateData} | Map | Map keyed by date granularity |
| data.y.{dateMap}.{key} | 2021-10-04 | String | Date string |
| data.y.{dateMap}.{value} | - | List | Table data |
| data.y.{dateMap}.{value}.isTotal | false | Boolean | Whether it's the total |
| data.y.{dateMap}.{value}.values | - | List | Main aggregate values |
| data.y.{dateMap}.{value}.meanwhileValues | - | List | Also Show aggregate values |
Error response example
{
"return_code": -1008,
"return_message": "Parameter (token) is empty"
}
| Parameter name | Example value | Parameter type | Description |
|---|---|---|---|
| return_code | -1008 | Integer | Return code |
| return_message | Parameter (token) is empty | String | Return message |
2. Distribution Analysis full download
Endpoint URL
/open/streaming-download/distribution-analyze?token=xxx
Request method
POST
Content-Type
application/json
Request query parameters
| Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| token | xxx | String | Yes | Query key |
Request body parameters
{
"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": "User Unique ID",
"columnName": "#user_id",
"tableType": "event"
},
"timeParticleSize": "day"
},
"events": [
{
"analysis": "TIMES",
"analysisDesc": "Times",
"eventName": "LogOut",
"eventNameDisplay": "",
"filts": [],
"intervalType": "def",
"quota": "",
"relation": "and",
"type": "normal"
}
],
"projectId": 319,
"interval": "['1']",
"zoneOffset": 10
}
Request parameters
| $$Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| eventView | - | Object | Yes | Same as the parameters of the Distribution Analysis query API |
| events | - | List | Yes | Same as the parameters of the Distribution Analysis query API |
| projectId | 0 | Integer | Yes | Project ID |
| interval | ['1','2'] | String | Yes | Full download intervals |
| meanwhileOnly | Boolean | No | Whether to download only Also Show data. default: false | |
| zoneOffset | 10 | Integer | No | Time zone |
tip
You can export the request parameters directly from the Distribution Analysis page in AE and then add other parameters such as interval. You can capture these parameters from the full download page.
Response
Same as the Events Analysis full download in AE
3. Distribution Analysis user list
Endpoint URL
/open/distribution-user-list?token=xxx
Request method
POST
Content-Type
application/json
Request query parameters
| Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| token | xxx | String | Yes | Query key |
Request body parameters
{
"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": ["Beijing"],
"timeoutSeconds": 10,
"zoneOffset": 10
}
Request parameters
| $$Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| projectId | 0 | String | Yes | Description |
| eventView | - | Object | Yes | Same as the parameters of the Distribution Analysis query API |
| events | List | Yes | Same as the parameters of the Distribution Analysis query API | |
| interval | 10,20 | String | No | Range to drill down into |
| groupBit | 0 | Integer | No | Whether to drill down into the total column. 1 means the total column; other values mean non-total columns |
| sliceDate | "2019-11-18" | String | No | Date to drill down into |
| sliceGroupVal | ["Beijing"] | List | Yes | Group to drill down into |
| timeoutSeconds | 10 | Integer | No | Request timeout. The query task is canceled when it times out |
| zoneOffset | 10 | Integer | No | Time zone |
Success response example
{
"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": "Baidu Mobile Assistant",
"#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": "Huawei AppGallery",
"#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": "Tencent MyApp",
"#user_id": 1758186
}
],
"columMeta": {
"#account_id": "Account ID",
"#distinct_id": "Distinct ID",
"user_level": "User Level",
"register_time": "Registration Time",
"diamond_num": "Current Diamonds",
"first_recharge_time": "First Top-up Time",
"latest_login_time": "Last Login Time",
"channel": "Channel"
}
},
"return_code": 0,
"return_message": "success"
}
Response parameters
| $$Parameter name | Example value | Parameter type | Description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return message |
| data | - | Object | Returned result |
| data.datalist | - | List<Map> | User information |
| data.columMeta | - | Map | Mapping of field meanings |
Error response example
{
"return_code": -1008,
"return_message": "Parameter (token) is empty"
}
| Parameter name | Example value | Parameter type | Description |
|---|---|---|---|
| return_code | -1008 | Integer | Return code |
| return_message | Parameter (token) is empty | String | Return message |
4. Distribution Analysis user list download
Endpoint URL
/open/streaming-download/distribution-user-list?token=xxx
Request method
POST
Content-Type
application/json
Request query parameters
| Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| token | xxx | String | Yes | Query key |
Request body parameters
{
"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": "User Unique ID",
"columnName": "#user_id",
"tableType": "event"
},
"timeParticleSize": "day"
},
"events": [
{
"analysis": "TIMES",
"analysisDesc": "Times",
"eventName": "LogOut",
"eventNameDisplay": "",
"filts": [],
"intervalType": "def",
"quota": "",
"relation": "and",
"type": "normal"
}
],
"projectId": 319,
"groupBit": 0,
"sliceDate": "2022-03-01",
"sliceGroupVal": [
"VIVO App Store"
],
"selectedColumns": [
"#account_id",
"#distinct_id"
],
"zoneOffset": 10
}
Request parameters
| $$Parameter name | Example value | Parameter type | Required | Description |
|---|---|---|---|---|
| projectId | 0 | String | Yes | Description |
| eventView | - | Object | Yes | Same as the parameters of the Distribution Analysis query API |
| events | - | List | Yes | Same as the parameters of the Distribution Analysis query API |
| interval | 10,20 | String | Yes | Range to drill down into |
| groupBit | 0 | Integer | No | Whether to drill down into the total column. 1 means the total column; other values mean non-total columns |
| sliceDate | "2019-11-18" | String | No | Date to drill down into |
| sliceGroupVal | ["Beijing"] | List | Yes | Group to drill down into |
| selectedColumns | ["#account_id"] | array | No | Columns to download |
| zoneOffset | 10 | Integer | No | Time zone |
Response
Same as the Distribution Analysis user list download in AE
Distribution Analysis common enums
Distribution aggregation type enum values
| Value | Description | Requires property |
|---|---|---|
| TIMES | Times | No |
| NUMBER_OF_DAYS | Days | No |
| NUMBER_OF_HOURS | Hours | No |
| SUM | Sum | Yes |
| AVG | Average | Yes |
| MAX | Maximum | Yes |
| MIN | Minimum | Yes |
| DISTINCT | Deduplication | Yes |
| TRUE | True totals | Yes |
| FALSE | False totals | Yes |
| IS_NOT_EMPTY | Not null totals | Yes |
| IS_EMPTY | Null totals | Yes |
| ARRAY_DISTINCT | Deduplication of array | Yes |
| ARRAY_SET_DISTINCT | Deduplication of set | Yes |
| ARRAY_ITEM_DISTINCT | Deduplication of element | Yes |
| MEDIAN | Median | Yes |
Was this page helpful?