리텐션 분석 모델 API
호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.
사용 시나리오는 사용 설명서의 리텐션 분석을 참조하십시오.
1. 리텐션 분석 조회
인터페이스 URL
/open/retention-analyze?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView":{
"endTime":"2021-10-30 23:59:59",
"filts":[
{
"columnDesc":"app 버전",
"columnName":"app_version",
"comparator":"equal",
"filterType":"SIMPLE",
"ftv":[
"V1.0"],
"specifiedClusterDate":"2022-01-24",
"tableType":"event",
"timeUnit":""
}],
"firstDayOfWeek":1,
"groupBy":[
{
"columnDesc":"브라우저",
"columnName":"browser",
"propertyRange":"",
"specifiedClusterDate":"2022-01-24",
"tableType":"event"
}],
"recentDay":"",
"relation":"and",
"startTime":"2021-10-01 00:00:00",
"statType":"retention",
"taIdMeasureVo":{
"columnDesc":"유저 고유 ID",
"columnName":"#user_id",
"tableType":"event"
},
"timeParticleSize":"week",
"unitNum":1
},
"events":[
{
"eventName":"login",
"eventNameDisplay":"",
"filts":[
{
"columnDesc":"app_version",
"columnName":"app_version",
"comparator":"equal",
"filterType":"SIMPLE",
"ftv":["V1.0"],
"specifiedClusterDate":"2022-01-26",
"tableType":"event",
"timeUnit":""
}],
"relation":"and",
"relationUser":"and",
"type":"first"
},
{
"eventName":"logout",
"eventNameDisplay":"",
"filts":[
],
"relation":"and",
"relationUser":"and",
"type":"second"
},
{
"analysis":"TOTAL_TIMES",
"analysisDesc":"총 횟수",
"eventName":"activity_attend",
"eventNameDisplay":"",
"filts":[
],
"quota":"",
"relation":"and",
"relationUser":"and",
"type":"simultaneous_display"
}],
"projectId": 377,
"limit": 2,
"timeoutSeconds": 10,
"useCache": true,
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| eventView | - | Object | 예 | 지표 공통 속성 부분 |
| eventView.endTime | 2021-10-30 23:59:59 | String | 아니요 | 종료 시간(형식: yyyy-MM-dd HH:mm:ss). 상대 시간이 비어 있을 때 유효 |
| eventView.filts | - | List | 아니요 | 전체 필터 항목 |
| eventView.filts.columnDesc | 앱 버전 | String | 아니요 | 필드 표시 이름 |
| eventView.filts.columnName | app_version | String | 예 | 필드 이름 |
| eventView.filts.comparator | equal | String | 예 | 참고: 모델 조회 API의 필터 표현식 |
| eventView.filts.filterType | SIMPLE | String | 아니요 | 필터 모드. SIMPLE: 단순, COMPOUND: 복합 |
| eventView.filts.ftv | ["V1.0"] | List | 아니요 | 속성 비교 경계에 사용하는 리터럴 상수 |
| eventView.filts.specifiedClusterDate | 2022-01-24 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| eventView.filts.tableType | event | String | 예 | 테이블 유형 열거형 값 |
| eventView.filts.timeUnit | String | 아니요 | 속성 비교 값 단위. relativeEvent*에만 유효: day, hour, minute | |
| eventView.firstDayOfWeek | 1 | Integer | 아니요 | timeParticleSize가 week일 때 주의 첫날을 지정. 1: 월요일, 2: 화요일, ..., 7: 일요일. 최소 1, 최대 7 |
| eventView.groupBy | - | List | 아니요 | 그룹 속성. 0개 이상 지정 가능 |
| eventView.groupBy.columnDesc | 브라우저 | String | 아니요 | 필드 표시 이름 |
| eventView.groupBy.columnName | browser | String | 예 | 필드 이름 |
| eventView.groupBy.propertyRange | String | 아니요 | 커스텀 속성 구간 | |
| eventView.groupBy.specifiedClusterDate | 2022-01-24 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| eventView.groupBy.tableType | event | 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.statType | retention | String | 예 | 통계 타입, 잔존: retention, 이탈: lost |
| eventView.taIdMeasureVo | - | Object | 아니요 | 분석 주체 설정 |
| eventView.taIdMeasureVo.columnDesc | 유저 고유 ID | String | 아니요 | 필드 표시 이름 |
| eventView.taIdMeasureVo.columnName | #user_id | String | 예 | 필드 이름 |
| eventView.taIdMeasureVo.tableType | event | String | 예 | 테이블 유형 열거형 값 |
eventView.timeParticleSize | week | String | 예 | 분석 시간 단위
|
| eventView.unitNum | 1 | Integer | 예 | 리텐션 기간 |
| events | - | List | 예 | 이벤트 지표 목록 |
| events.eventName | login | String | 예 | 지표 이벤트 이름. anyEvent로 임의의 이벤트를 나타낼 수 있음 |
| events.eventNameDisplay | String | 아니요 | 커스텀 지표 표시 이름 | |
| events.analysis | TRIG_USER_NUM | String | 아니요 | 분석 관점(집계 연산)이며, 자세한 내용은 리텐션 함께 보기 집계 타입 열거형 값을 참조하십시오 |
| events.analysisDesc | 총 횟수 | String | 아니요 | 분석 관점 설명 |
| events.quota | String | 아니요 | 지표 속성(analysis와 함께 사용하며, 어떤 속성의 어떤 분석 관점인지를 의미) | |
| events.filts | - | List | 아니요 | 조건 목록 |
| events.filts.columnDesc | app_version | 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: 논리합 |
| events.relationUser | and | String | 아니요 | 유저 필터 논리 관계, and: 논리곱(AND), or: 논리합(OR) |
events.type | first | String | 예 | 리텐션 이벤트 타입
|
| 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-01 00:00:00",
"state_avg": {
"0": [
{
"groupCols": [
"전체"
],
"initNum": 0,
"isTotal": 1,
"lastValidDateVerticalIndexs": [
"-",
"4"
],
"values": [
"-",
"0.998"
]
},
{
"groupCols": [
"Chrome"
],
"initNum": 0,
"isTotal": 0,
"lastValidDateVerticalIndexs": [
"-",
"4"
],
"values": [
"-",
"0.9981"
]
}
],
"1": [
{
"groupCols": [
"전체"
],
"initNum": 0,
"isTotal": 1,
"lastValidDateVerticalIndexs": [
"-",
"4"
],
"values": [
"-",
"1"
]
},
{
"groupCols": [
"Chrome"
],
"initNum": 0,
"isTotal": 0,
"lastValidDateVerticalIndexs": [
"-",
"4"
],
"values": [
"-",
"1"
]
}
],
"2": [
{
"groupCols": [
"전체"
],
"initNum": 0,
"isTotal": 1,
"lastValidDateVerticalIndexs": [],
"values": [
"-",
"132405.4"
]
},
{
"groupCols": [
"Chrome"
],
"initNum": 0,
"isTotal": 0,
"lastValidDateVerticalIndexs": [],
"values": [
"-",
"66343.2"
]
}
]
},
"x": [
"2021-09-27",
"2021-10-04",
"2021-10-11",
"2021-10-18",
"2021-10-25"
],
"y": {
"0": {
"2021-09-27": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7388,
"isTotal": 1,
"values": [
"7388",
"7374"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3647,
"isTotal": 0,
"values": [
"3647",
"3642"
]
}
],
"2021-10-04": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7861,
"isTotal": 1,
"values": [
"7861",
"7844"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3939,
"isTotal": 0,
"values": [
"3939",
"3930"
]
}
],
"2021-10-11": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 8013,
"isTotal": 1,
"values": [
"8013",
"7994"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 4062,
"isTotal": 0,
"values": [
"4062",
"4054"
]
}
],
"2021-10-18": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 8553,
"isTotal": 1,
"values": [
"8553",
"8543"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 4225,
"isTotal": 0,
"values": [
"4225",
"4218"
]
}
],
"2021-10-25": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7414,
"isTotal": 1,
"values": [
"7414",
"7397"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3741,
"isTotal": 0,
"values": [
"3741",
"3733"
]
}
]
},
"1": {
"2021-09-27": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7388,
"isTotal": 1,
"values": [
"7388",
"7388"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3647,
"isTotal": 0,
"values": [
"3647",
"3647"
]
}
],
"2021-10-04": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7861,
"isTotal": 1,
"values": [
"7861",
"7861"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3939,
"isTotal": 0,
"values": [
"3939",
"3939"
]
}
],
"2021-10-11": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 8013,
"isTotal": 1,
"values": [
"8013",
"8013"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 4062,
"isTotal": 0,
"values": [
"4062",
"4062"
]
}
],
"2021-10-18": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 8553,
"isTotal": 1,
"values": [
"8553",
"8553"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 4225,
"isTotal": 0,
"values": [
"4225",
"4225"
]
}
],
"2021-10-25": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7414,
"isTotal": 1,
"values": [
"7414",
"7414"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3741,
"isTotal": 0,
"values": [
"3741",
"3741"
]
}
]
},
"2": {
"2021-09-27": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7388,
"isTotal": 1,
"values": [
"0",
"125324"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3647,
"isTotal": 0,
"values": [
"0",
"62105"
]
}
],
"2021-10-04": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7861,
"isTotal": 1,
"values": [
"0",
"132130"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3939,
"isTotal": 0,
"values": [
"0",
"65971"
]
}
],
"2021-10-11": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 8013,
"isTotal": 1,
"values": [
"0",
"134691"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 4062,
"isTotal": 0,
"values": [
"0",
"68566"
]
}
],
"2021-10-18": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 8553,
"isTotal": 1,
"values": [
"0",
"144030"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 4225,
"isTotal": 0,
"values": [
"0",
"71345"
]
}
],
"2021-10-25": [
{
"groupCols": [
"전체"
],
"includeToday": false,
"initNum": 7414,
"isTotal": 1,
"values": [
"0",
"125852"
]
},
{
"groupCols": [
"Chrome"
],
"includeToday": false,
"initNum": 3741,
"isTotal": 0,
"values": [
"0",
"63729"
]
}
]
}
},
"z": [
"login",
"logout",
"activity_attend"
]
},
"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.state_avg | - | Object | 결과 map, key는 type, value는 리텐션 그룹 |
| data.state_avg.{type} | - | List | type 값, 0: 잔존, 1: 이탈, 2: 동시 표시 지표 |
| data.state_avg.{type}.groupCols | ["전체"] | List | 그룹 열 |
| data.state_avg.{type}.initNum | 0 | Integer | 초기값 |
| data.state_avg.{type}.isTotal | 1 | Integer | 합계 여부, 1: 예, 0: 아니요 |
| data.state_avg.{type}.lastValidDateVerticalIndexs | ["-", "4"] | List | 마지막 완전한 데이터 날짜 인덱스 |
| data.state_avg.{type}.values | ["-", "0.998"] | List | 값 리스트, "-" 또는 숫자 |
| data.x | ["2021-09-27"] | List | 날짜 리스트 |
| data.y | - | Object | y축 데이터 |
| data.y.{type} | - | Object | type 값, 0: 잔존, 1: 이탈, 2: 통계 |
| data.y.{type}.{date} | - | List | key는 날짜 |
| data.y.{type}.{date}.groupCols | ["전체"] | List | 그룹 열 |
| data.y.{type}.{date}.includeToday | false | Boolean | 오늘 포함 여부 |
| data.y.{type}.{date}.initNum | 7388 | Integer | 초기값 |
| data.y.{type}.{date}.isTotal | 1 | Integer | 합계 여부, 1: 예, 0: 아니요 |
| data.y.{type}.{date}.values | ["7388"] | List | 값 리스트 |
| data.z | ["login"] | List | 이벤트 이름 리스트 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
2. 리텐션 분석 전체 다운로드
인터페이스 URL
/open/streaming-download/retention-analyze?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView": {
"collectFirstDay": 1,
"endTime": "2022-03-08 16:55:10",
"filts": [],
"groupBy": [{
"columnDesc": "채널",
"columnName": "channel",
"propertyRange": "",
"specifiedClusterDate": "2022-03-09",
"tableType": "event"
}],
"recentDay": "1-7",
"relation": "and",
"startTime": "2022-03-02 16:55:10",
"statType": "retention",
"taIdMeasureVo": {
"columnDesc": "유저 고유 ID",
"columnName": "#user_id",
"tableType": "event"
},
"timeParticleSize": "day",
"unitNum": 7
},
"events": [{
"eventName": "Recharge",
"eventNameDisplay": "",
"filts": [],
"relation": "and",
"relationUser": "and",
"type": "first"
}],
"projectId": 390
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| eventView | - | Object | 예 | 리텐션 분석 조회 API와 파라미터 내용이 같음 |
| events | - | List | 예 | 리텐션 분석 조회 API와 파라미터 내용이 같음 |
| projectId | 377 | Integer | 예 | 프로젝트 ID |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
응답
AE 시스템의 리텐션 분석 전체 다운로드와 동일
3. 리텐션 분석 유저 목록
인터페이스 URL
/open/retention-user-list?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"projectId": 0,
"eventView": {
"startTime": "2019-11-24 00:00:00",
"endTime": "2019-11-26 00:00:00",
"recentDay": "1-3",
"statType": "retention",
"timeParticleSize": "day",
"unitNum": 7,
"groupBy": [
{
"columnName": "#province",
"tableType": "event"
}
]
},
"events": [
{
"type": "first",
"relation": "and",
"eventName": "player_register",
"filts": [
{
"columnName": "#province",
"comparator": "equal",
"ftv": [
"장쑤성",
"상하이시"
],
"tableType": "event"
},
{
"columnName": "user_level",
"comparator": "greater",
"ftv": [
"2"
],
"tableType": "user"
}
]
},
{
"type": "second",
"relation": "and",
"eventName": "obtain_diamond",
"filts": [
{
"columnName": "#os",
"comparator": "equal",
"ftv": [
"android"
],
"tableType": "event"
},
{
"$ref": "$.events[0].filts[1]"
}
]
}
],
"sliceDate": "2019-11-26",
"sliceInterval": 3,
"timeoutSeconds": 10,
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| projectId | 0 | String | 예 | 파라미터 설명 |
| eventView | - | Object | 예 | 리텐션 분석 조회 API와 파라미터 내용이 같음 |
| events | List | 예 | 리텐션 분석 조회 API와 파라미터 내용이 같음 | |
| sliceDate | "2019-11-26" | String | 아니요 | 드릴다운할 날짜 |
| sliceGroupVal | ["베이징시"] | List | 예 | 드릴다운할 그룹 |
sliceInterval | 3 | List | 예 | 드릴다운할 리텐션 간격
|
| timeoutSeconds | 10 | Integer | 아니요 | 요청 시간 초과 파라미터, 시간이 초과되면 쿼리 작업을 취소합니다 |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
성공 응답 예시
{
"data": {
"datalist": [
{
"#account_id": "v47739399",
"#distinct_id": "v88658799",
"user_level": 11,
"register_time": "2019-11-26 19:13:20",
"diamond_num": 1182,
"latest_login_time": "2019-11-26 20:16:19",
"channel": "Huawei AppGallery",
"#user_id": 20459799
},
{
"#account_id": "i7819568",
"#distinct_id": "i14522048",
"user_level": 4,
"register_time": "2019-11-26 23:56:17",
"diamond_num": 1006,
"latest_login_time": "2019-11-26 23:59:59",
"channel": "360 Mobile Assistant",
"#user_id": 3351248
},
{
"#account_id": "g7812426",
"#distinct_id": "g14508786",
"user_level": 14,
"register_time": "2019-11-26 17:54:13",
"diamond_num": 245,
"first_recharge_time": "2019-11-26 18:08:58",
"latest_login_time": "2019-11-26 20:16:19",
"channel": "Xiaomi GetApps",
"#user_id": 3348186
},
{
"#account_id": "a7812000",
"#distinct_id": "a14508000",
"user_level": 3,
"register_time": "2019-11-26 17:27:28",
"diamond_num": 1153,
"latest_login_time": "2019-11-26 18:45:58",
"channel": "app store",
"#user_id": 3348000
}
],
"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/retention-user-list?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView": {
"collectFirstDay": 1,
"endTime": "2022-03-07 17:09:58",
"filts": [],
"groupBy": [],
"recentDay": "1-7",
"relation": "and",
"startTime": "2022-03-01 17:09:58",
"statType": "retention",
"taIdMeasureVo": {
"columnDesc": "User ID",
"columnName": "#user_id",
"tableType": "event"
},
"timeParticleSize": "day",
"unitNum": 7
},
"events": [{
"eventName": "Login",
"eventNameDisplay": "",
"filts": [],
"relation": "and",
"relationUser": "and",
"type": "first"
}, {
"eventName": "Recharge",
"eventNameDisplay": "",
"filts": [],
"relation": "and",
"relationUser": "and",
"type": "second"
}],
"projectId": 319,
"isLost": false,
"sliceDate": "2022-03-01",
"sliceInterval": 0,
"selectedColumns": ["#account_id", "#distinct_id"],
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| eventView | - | Object | 예 | 리텐션 분석 조회 API와 파라미터 내용이 같음 |
| events | - | List | 예 | 리텐션 분석 조회 API와 파라미터 내용이 같음 |
| projectId | 377 | Integer | 예 | 프로젝트 ID |
| isLost | false | boolean | 아니요 | 이탈 여부 |
| sliceDate | "2019-11-26" | String | 아니요 | 이벤트 발생 날짜 |
| sliceGroupVal | ["베이징시"] | List | 예 | 드릴다운할 그룹 |
| sliceInterval | 0 | Integer | 예 | 드릴다운할 리텐션 간격
|
| selectedColumns | ["#account_id"] | List | 예 | 다운로드할 열 |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
요청 파라미터 본문은 AE 시스템의 리텐션 분석 페이지에서 내보낼 수 있으며, 여기에 isLost, sliceDate, sliceGroupVal, sliceInterval, selectedColumns 파라미터를 추가합니다
응답
AE 시스템의 리텐션 분석 유저 목록 전체 다운로드와 동일
리텐션 분석 공통 열거형
리텐션 함께 보기 집계 타입 열거형 값
| 값 | 설명 | 속성 필요 여부 |
|---|---|---|
| TOTAL_TIMES | 총 횟수 | 아니요 |
| TRIG_USER_NUM | 유니크 유저 수 | 아니요 |
| PER_CAPITA_TIMES | 1인당 평균 횟수 | 아니요 |
| SUM | 수치 합계 | 예 |
| PER_CAPITA_NUM | 1인당 평균 | 예 |
| STAGE_ACC | 누적 합계 | 예 |
| STAGE_ACC_PCV | 단계별 누적 1인당 평균 | 예 |
| TRUE | 참 값 수 | 예 |
| FALSE | 거짓 값 수 | 예 |
| IS_NOT_EMPTY | Not Null 값 수 | 예 |
| IS_EMPTY | Null 값 수 | 예 |

