manuallatest제품 매뉴얼 / 퍼널 분석 모델 API
퍼널 분석 모델 API
호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.
사용 시나리오는 사용 설명서의 퍼널 분석을 참조하십시오.
1. 퍼널 분석 조회
인터페이스 URL
/open/funnel-analyze?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView":{
"endTime":"2021-10-31 23:59:59",
"filts":[
{
"columnDesc":"도시",
"columnName":"city",
"comparator":"equal",
"filterType":"SIMPLE",
"ftv":[
"상하이시",
"베이징시",
"광저우시",
"선전시"],
"specifiedClusterDate":"2022-01-24",
"tableType":"user",
"timeUnit":""
}],
"groupBy":[
{
"columnDesc":"도시",
"columnName":"city",
"propertyRange":"",
"specifiedClusterDate":"2022-01-24",
"tableType":"user"
}],
"recentDay":"",
"relation":"and",
"startTime":"2021-10-01 00:00:00",
"taIdMeasureVo":{
"columnDesc":"유저 고유 ID",
"columnName":"#user_id",
"tableType":"event"
},
"windows_gap":1,
"windows_gap_tu":"hour"
},
"events":[
{
"eventName":"register",
"eventNameDisplay":"",
"filts":[
{
"columnDesc":"app 버전",
"columnName":"app_version",
"comparator":"equal",
"filterType":"SIMPLE",
"ftv":[
"V1.0"],
"specifiedClusterDate":"2022-01-26",
"tableType":"event",
"timeUnit":""
}],
"relation":"and"
},
{
"eventName":"login",
"eventNameDisplay":"",
"filts":[
],
"relation":"and"
},
{
"eventName":"activity_attend",
"eventNameDisplay":"",
"filts":[
],
"relation":"and"
},
{
"eventName":"logout",
"eventNameDisplay":"",
"filts":[
],
"relation":"and"
}
],
"projectId":377,
"limit": 2,
"timeoutSeconds": 10,
"useCache": true,
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| eventView | - | Object | 예 | 지표 공통 속성 부분 |
| eventView.endTime | 2021-10-31 23:59:59 | String | 아니요 | 종료 시간(형식: yyyy-MM-dd HH:mm:ss). 상대 시간이 비어 있을 때 유효 |
| eventView.filts | - | List | 아니요 | 전체 필터 항목 |
| eventView.filts.columnDesc | 도시 | String | 아니요 | 필드 표시 이름 |
| eventView.filts.columnName | city | String | 예 | 필드 이름 |
| eventView.filts.comparator | equal | String | 예 | 참고: 모델 조회 API의 필터 표현식 |
| eventView.filts.filterType | SIMPLE | String | 아니요 | 필터 모드. SIMPLE: 단순, COMPOUND: 복합 |
| eventView.filts.ftv | ["상하이시"] | List | 아니요 | 속성 비교 경계에 사용하는 리터럴 상수 |
| eventView.filts.specifiedClusterDate | 2022-01-24 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| eventView.filts.tableType | user | String | 예 | 테이블 유형 열거형 값 |
| eventView.filts.timeUnit | String | 아니요 | 속성 비교 값 단위. relativeEvent*에만 유효: day, hour, minute | |
| eventView.groupBy | - | List | 아니요 | 그룹 속성. 0개 이상 지정 가능 |
| eventView.groupBy.columnDesc | 도시 | String | 아니요 | 필드 표시 이름 |
| eventView.groupBy.columnName | city | String | 예 | 필드 이름 |
| eventView.groupBy.propertyRange | String | 아니요 | 커스텀 속성 구간 | |
| eventView.groupBy.specifiedClusterDate | 2022-01-24 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| eventView.groupBy.tableType | user | String | 예 | 테이블 유형 열거형 값 |
| eventView.recentDay | String | 아니요 | 상대 시간(시작 시간, 종료 시간과 함께 모두 비워 둘 수 없음) | |
| eventView.relation | and | String | 아니요 | 논리 관계. and: 논리곱, or: 논리합 |
| eventView.startTime | 2021-10-01 00:00:00 | String | 아니요 | 시작 시간(형식: yyyy-MM-dd HH:mm:ss). 상대 시간이 비어 있을 때 유효 |
| eventView.taIdMeasureVo | - | Object | 아니요 | 분석 주체 설정 |
| eventView.taIdMeasureVo.columnDesc | 유저 고유 ID | String | 아니요 | 필드 표시 이름 |
| eventView.taIdMeasureVo.columnName | #user_id | String | 예 | 필드 이름 |
| eventView.taIdMeasureVo.tableType | event | String | 예 | 테이블 유형 열거형 값 |
| eventView.windows_gap | 1 | Long | 아니요 | 윈도우 기간 |
| eventView.windows_gap_tu | hour | String | 아니요 | 윈도우 기간 단위
|
| events | - | List | 예 | 이벤트 지표 목록 |
| events.eventName | register | String | 예 | 지표 이벤트 이름. anyEvent로 임의의 이벤트를 나타낼 수 있음 |
| events.eventNameDisplay | String | 아니요 | 커스텀 지표 표시 이름 | |
| events.filts | - | List | 아니요 | 조건 필터 목록 |
| events.filts.columnDesc | 앱 버전 | String | 아니요 | 필드 표시 이름 |
| events.filts.columnName | app_version | String | 예 | 필드 이름 |
| events.filts.comparator | equal | String | 예 | 참고: 모델 조회 API의 필터 표현식 |
| events.filts.filterType | SIMPLE | String | 아니요 | 필터 모드. SIMPLE: 단순, COMPOUND: 복합 |
| events.filts.ftv | ["V1.0"] | List | 아니요 | 속성 비교 경계에 사용하는 리터럴 상수 |
| events.filts.specifiedClusterDate | 2022-01-26 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| events.filts.tableType | event | String | 예 | 테이블 유형 열거형 값 |
| events.filts.timeUnit | String | 아니요 | 필터 시간 단위 | |
| events.relation | and | String | 아니요 | 논리 관계. and: 논리곱, or: 논리합 |
| projectId | 377 | Integer | 예 | 프로젝트 ID |
| limit | 2 | Integer | 아니요 | 분석 대상별 그룹 수 상한. 선택 파라미터이며 기본값은 1000, 최댓값은 10000 |
| timeoutSeconds | 10 | Integer | 아니요 | 요청 시간 초과 파라미터, 시간이 초과되면 쿼리 작업을 취소합니다 |
| useCache | true | Boolean | 예 | true이면 캐시 사용 |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
성공 응답 예시
{
"data": {
"result_generate_time": "2022-01-26 19:23:51",
"total": 5,
"x": [
"2021-10-01",
"2021-10-02",
"2021-10-03",
"2021-10-04",
"2021-10-05",
"2021-10-06",
"2021-10-07",
"2021-10-08",
"2021-10-09",
"2021-10-10",
"2021-10-11",
"2021-10-12",
"2021-10-13",
"2021-10-14",
"2021-10-15",
"2021-10-16",
"2021-10-17",
"2021-10-18",
"2021-10-19",
"2021-10-20",
"2021-10-21",
"2021-10-22",
"2021-10-23",
"2021-10-24",
"2021-10-25",
"2021-10-26",
"2021-10-27",
"2021-10-28",
"2021-10-29",
"2021-10-30",
"2021-10-31"
],
"y": [
{
"전체": {
"col1": [
5666,
197,
197,
197
],
"col2": [
[
208,
10,
10,
10
],
[
205,
4,
4,
4
],
[
189,
5,
5,
5
],
[
229,
10,
10,
10
],
[
217,
6,
6,
6
],
[
257,
10,
10,
10
],
[
233,
6,
6,
6
],
[
207,
7,
7,
7
],
[
204,
7,
7,
7
],
[
248,
14,
14,
14
],
[
217,
4,
4,
4
],
[
207,
9,
9,
9
],
[
219,
8,
8,
8
],
[
220,
4,
4,
4
],
[
193,
10,
10,
10
],
[
218,
9,
9,
9
],
[
232,
7,
7,
7
],
[
222,
10,
10,
10
],
[
220,
8,
8,
8
],
[
203,
6,
6,
6
],
[
217,
8,
8,
8
],
[
239,
3,
3,
3
],
[
214,
5,
5,
5
],
[
197,
11,
11,
11
],
[
199,
8,
8,
8
],
[
135,
7,
7,
7
],
[
73,
1,
1,
1
],
[
33,
0,
0,
0
],
[
11,
0,
0,
0
],
[
0,
0,
0,
0
],
[
0,
0,
0,
0
]
]
}
},
{
"베이징시": {
"col1": [
2028,
70,
70,
70
],
"col2": [
[
79,
1,
1,
1
],
[
71,
2,
2,
2
],
[
65,
0,
0,
0
],
[
74,
3,
3,
3
],
[
72,
2,
2,
2
],
[
89,
3,
3,
3
],
[
88,
2,
2,
2
],
[
75,
3,
3,
3
],
[
66,
4,
4,
4
],
[
95,
1,
1,
1
],
[
60,
1,
1,
1
],
[
68,
5,
5,
5
],
[
80,
5,
5,
5
],
[
68,
2,
2,
2
],
[
67,
6,
6,
6
],
[
84,
4,
4,
4
],
[
84,
1,
1,
1
],
[
87,
1,
1,
1
],
[
79,
6,
6,
6
],
[
76,
1,
1,
1
],
[
81,
3,
3,
3
],
[
85,
1,
1,
1
],
[
89,
2,
2,
2
],
[
75,
3,
3,
3
],
[
74,
5,
5,
5
],
[
49,
2,
2,
2
],
[
26,
1,
1,
1
],
[
16,
0,
0,
0
],
[
6,
0,
0,
0
],
[
0,
0,
0,
0
],
[
0,
0,
0,
0
]
]
}
}
],
"z": [
"register",
"login",
"activity_attend",
"logout"
]
},
"return_code": 0,
"return_message": "success"
}
응답 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
| data | - | Object | 반환 결과 |
| data.result_generate_time | 2022-01-01 00:00:00 | String | 계산 결과 생성 시간 |
| data.total | 5 | Integer | 총계 |
| data.x | ["2021-10-01"] | List | 시간 리스트 |
| data.y | - | List<Map> | 데이터 리스트 |
| data.z | ["register"] | List | 이벤트 이름 리스트 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
2. 퍼널 분석 전체 다운로드
인터페이스 URL
/open/streaming-download/funnel-analyze?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView": {
"endTime": "2022-03-07 17:27:29",
"filts": [],
"groupBy": [],
"recentDay": "1-7",
"relation": "and",
"startTime": "2022-03-01 17:27:29",
"taIdMeasureVo": {
"columnDesc": "User ID",
"columnName": "#user_id",
"tableType": "event"
},
"windows_gap": 1,
"windows_gap_tu": "day"
},
"events": [{
"eventName": "Login",
"eventNameDisplay": "",
"filts": [],
"relation": "and"
}, {
"eventName": "LogOut",
"eventNameDisplay": "",
"filts": [],
"relation": "and"
}],
"projectId": 319,
"timeView": "TOTAL_TIME",
"resultType": "CONVERSION",
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| eventView | - | Object | 예 | 퍼널 분석 조회 API와 파라미터 내용이 같음 |
| events | - | List | 예 | 퍼널 분석 조회 API와 파라미터 내용이 같음 |
| projectId | 377 | Integer | 예 | 프로젝트 ID |
| timeView | TOTAL_TIME | String | 아니요 | 시간 관점: TOTAL_TIME(합계), PER_DATE(일별) |
| resultType | CONVERSION | String | 아니요 | 결과 타입: CONVERSION(전환), DROP_OFF(이탈) |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
응답
AE 시스템의 퍼널 분석 전체 다운로드와 동일
3. 퍼널 분석 유저 목록
인터페이스 URL
/open/funnel-user-list?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
요청 Body 파라미터
{
"projectId": 0,
"eventView": {
"startTime": "2019-11-23 00:00:00",
"endTime": "2019-11-26 00:00:00",
"recentDay": "1-4",
"relation": "and",
"timeParticleSize": "day",
"filts": [
{
"columnName": "user_level",
"comparator": "equal",
"ftv": [
"5"
],
"tableType": "user"
}
],
"groupBy": [
{
"columnName": "#province",
"tableType": "event"
}
]
},
"events": [
{
"eventName": "obtain_item",
"relation": "and",
"filts": [
{
"columnName": "#province",
"comparator": "equal",
"ftv": [
"장쑤성",
"상하이시"
],
"tableType": "event"
}
]
}
],
"sliceFunnelStep": 1,
"sliceGroupVal": "['상하이시']",
"timeoutSeconds": 10,
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| projectId | 0 | String | 예 | 파라미터 설명 |
| eventView | - | Object | 예 | 퍼널 분석 조회 API와 파라미터 내용이 같음 |
| events | List | 예 | 퍼널 분석 조회 API와 파라미터 내용이 같음 | |
| sliceFunnelStep | 1 | Integer | 예 | 드릴다운할 퍼널 단계, 1부터 시작 |
| sliceGroupVal | "['상하이시']" | List | 아니요 | 드릴다운할 그룹 |
| sliceWastageUser | false | Boolean | 아니요 | 이탈 유저 여부, true: 예, false: 아니요 |
| timeoutSeconds | 10 | Integer | 아니요 | 요청 시간 초과 파라미터, 시간이 초과되면 쿼리 작업을 취소합니다 |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
성공 응답 예시
{
"data": {
"datalist": [
{
"#account_id": "u78082246",
"#distinct_id": "u145009846",
"user_level": 5,
"register_time": "2019-11-26 09:59:34",
"diamond_num": 1006,
"latest_login_time": "2019-11-26 11:14:12",
"channel": "Xiaomi GetApps",
"#user_id": 33463846
},
{
"#account_id": "k77655236",
"#distinct_id": "k144216836",
"user_level": 5,
"register_time": "2019-11-24 08:53:09",
"diamond_num": 1012,
"latest_login_time": "2019-11-24 10:02:38",
"channel": "Wandoujia",
"#user_id": 33280836
},
{
"#account_id": "a77648226",
"#distinct_id": "a144203826",
"user_level": 5,
"register_time": "2019-11-24 08:21:19",
"diamond_num": 1006,
"latest_login_time": "2019-11-24 09:32:31",
"channel": "Tencent MyApp",
"#user_id": 33277826
}
],
"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_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
| data | - | Object | 반환 결과 |
| data.datalist | - | List<Map> | 유저 정보 |
| data.columMeta | - | Map | 필드 의미 매핑 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
4. 퍼널 분석 유저 목록 다운로드
인터페이스 URL
/open/streaming-download/funnel-user-list?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView": {
"endTime": "2022-03-07 17:27:29",
"filts": [],
"groupBy": [],
"recentDay": "1-7",
"relation": "and",
"startTime": "2022-03-01 17:27:29",
"taIdMeasureVo": {
"columnDesc": "User ID",
"columnName": "#user_id",
"tableType": "event"
},
"windows_gap": 1,
"windows_gap_tu": "day"
},
"events": [{
"eventName": "Login",
"eventNameDisplay": "",
"filts": [],
"relation": "and"
}, {
"eventName": "LogOut",
"eventNameDisplay": "",
"filts": [],
"relation": "and"
}],
"projectId": 319,
"sliceFunnelStep": 1,
"sliceWastageUser": false,
"selectedColumns": ["#account_id", "#distinct_id"],
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| projectId | 0 | String | 예 | 파라미터 설명 |
| eventView | - | Object | 예 | 퍼널 분석 조회 API와 파라미터 내용이 같음 |
| events | List | 예 | 퍼널 분석 조회 API와 파라미터 내용이 같음 | |
| sliceFunnelStep | 1 | Integer | 예 | 드릴다운할 퍼널 단계, 1부터 시작 |
| sliceGroupVal | "['상하이시']" | List | 아니요 | 드릴다운할 그룹 |
| sliceWastageUser | false | Boolean | 아니요 | 이탈 유저 여부, true: 예, false: 아니요 |
| selectedColumns | ["#account_id", "#distinct_id"] | Array | 아니요 | 다운로드할 열 |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
응답
AE 시스템의 퍼널 분석 유저 목록 다운로드와 동일
이 문서가 도움이 되었나요?