manuallatest제품 매뉴얼 / 경로 분석 모델 API
경로 분석 모델 API
호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.
사용 시나리오는 사용 설명서의 경로 분석을 참고하십시오.
1. 경로 분석 조회
인터페이스 URL
/open/path-analyze?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView": {
"col_limit": 10,
"from_date": "2021-10-01 00:00:00",
"recent_day": "",
"session_interval": 30,
"session_type": "minute",
"to_date": "2021-10-02 23:59:59"
},
"events": {
"by_fields": [
{
"event_name": "login",
"field": "browser",
"range": "",
"table_type": "event"
}],
"event_names": [
"logout",
"login"],
"source_event": {
"event_name": "login",
"filter": {
"filterType": "COMPOUND"
}
},
"source_type": "initial_event",
"user_filter": {
"filterType": "COMPOUND",
"filts": [
{
"columnDesc": "도시",
"columnName": "city",
"comparator": "equal",
"filterType": "SIMPLE",
"ftv": [
"베이징시",
"상하이시",
"광저우시",
"선전시"],
"specifiedClusterDate": "2022-01-24",
"tableType": "user"
}],
"relation": "and"
}
},
"projectId": 377,
"timeoutSeconds": 10,
"useCache": true,
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| eventView | - | Object | 예 | 지표 공통 속성 부분 |
| eventView.col_limit | 10 | Integer | 예 | 열 제한, 0~20 사이 |
| eventView.from_date | 2021-10-01 00:00:00 | String | 아니요 | 시작 시간 yyyy-MM-dd HH:mm:ss |
| eventView.recent_day | String | 아니요 | 상대 시간 | |
| eventView.session_interval | 30 | Integer | 예 | 세션 간격 시간 |
| eventView.session_type | minute | String | 예 | 세션 간격 시간 단위: second, minute, hour |
| eventView.to_date | 2021-10-02 23:59:59 | String | 아니요 | 종료 시간 yyyy-MM-dd HH:mm:ss |
| events | - | List | 예 | 이벤트 지표 목록 |
| events.by_fields | - | List | List | 이벤트 속성별 분할 |
| events.by_fields.event_name | login | String | 예 | 이벤트 이름 |
| events.by_fields.field | browser | String | 예 | 분할 필드 |
| events.by_fields.range_type | - | String | 아니요 | 구간 간격 유형
|
| events.by_fields.range | - | String | 아니요 | 구간 |
| events.by_fields.table_type | event | String | 예 | 테이블 타입. event: 이벤트 테이블, user: 유저 테이블 |
| events.event_names | ["logout","login"] | String | 예 | 이벤트 이름. 특히 anyEvent로 임의의 이벤트를 나타낼 수 있음 |
| events.source_event | - | Object | 예 | 소스 이벤트 |
| events.source_event.event_name | login | String | 예 | 이벤트 이름 |
| events.source_event.filter | - | Object | 아니요 | 소스 이벤트 필터 |
| events.source_event.filter.filterType | COMPOUND | String | 아니요 | 필터 모드. SIMPLE: 단순, COMPOUND: 복합 |
| events.source_type | initial_event | String | 예 | 이벤트 타입. initial_event, termination_event |
| events.user_filter | - | Object | 아니요 | 유저 테이블 필터 |
| events.user_filter.filterType | COMPOUND | String | 아니요 | 필터 모드. SIMPLE: 단순, COMPOUND: 복합 |
| events.user_filter.filts | - | List | 아니요 | 조건 목록 |
| events.user_filter.filts.columnDesc | app_version | String | 아니요 | 필드 표시 이름 |
| events.user_filter.filts.columnName | app_version | String | 예 | 필드 이름 |
| events.user_filter.filts.comparator | equal | String | 예 | 참고: 모델 조회 API의 필터 표현식 |
| events.user_filter.filts.filterType | SIMPLE | String | 아니요 | 필터 모드. SIMPLE: 단순, COMPOUND: 복합 |
| events.user_filter.filts.ftv | ["V1.0"] | List | 아니요 | 속성 비교 경계에 사용하는 리터럴 상수 |
| events.user_filter.filts.specifiedClusterDate | 2022-01-26 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| events.user_filter.filts.tableType | event | String | 예 | 테이블 타입. event: 이벤트 테이블, user: 유저 테이블 |
| events.user_filter.relation | and | String | 아니요 | 논리 관계. and: 논리곱, or: 논리합 |
| projectId | 377 | Integer | 예 | 프로젝트 ID |
| timeoutSeconds | 10 | Integer | 아니요 | 요청 시간 초과 파라미터, 시간이 초과되면 쿼리 작업을 취소합니다 |
| useCache | true | Boolean | 예 | true이면 캐시 사용 |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
성공 응답 예시
{
"data": {
"event_name_desc_map": {
"anyEvent": "임의의 이벤트",
"login": "로그인",
"logout": "유저 로그아웃"
},
"links": [
[
{
"source": "0_Chrome^_^login",
"target": "1_logout",
"times": 1716
},
{
"source": "0_Safari^_^login",
"target": "1_logout",
"times": 765
},
{
"source": "0_Firefox^_^login",
"target": "1_logout",
"times": 582
},
{
"source": "0_WeChat 내장 브라우저^_^login",
"target": "1_logout",
"times": 403
},
{
"is_wastage": true,
"source": "0_Chrome^_^login",
"target": "1_wastage",
"times": 380
},
{
"is_wastage": true,
"source": "0_Safari^_^login",
"target": "1_wastage",
"times": 195
},
{
"is_wastage": true,
"source": "0_Firefox^_^login",
"target": "1_wastage",
"times": 148
},
{
"is_wastage": true,
"source": "0_WeChat 내장 브라우저^_^login",
"target": "1_wastage",
"times": 89
}
]
],
"nodes": [
[
{
"by_value": "Chrome",
"event_name": "login",
"id": "0_Chrome^_^login",
"times": 2096
},
{
"by_value": "Safari",
"event_name": "login",
"id": "0_Safari^_^login",
"times": 960
},
{
"by_value": "Firefox",
"event_name": "login",
"id": "0_Firefox^_^login",
"times": 730
},
{
"by_value": "WeChat 내장 브라우저",
"event_name": "login",
"id": "0_WeChat 내장 브라우저^_^login",
"times": 492
}
],
[
{
"event_name": "logout",
"id": "1_logout",
"times": 3466
}
]
],
"result_generate_time": "2022-01-27 13:44:38"
},
"return_code": 0,
"return_message": "success"
}
응답 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
| data | - | Object | 반환 데이터 |
| data.event_name_desc_map | - | Map | 이벤트 이름과 이벤트 설명의 매핑 |
| data.links | - | List<List> | 관계 행렬 |
| data.links.source | 0_Chrome^_^login | String | 관계 시작 노드 |
| data.links.target | 1_level_up | String | 관계 종료 노드 |
| data.links.times | 5106 | Integer | 횟수 |
| data.nodes | - | List<List> | 노드 행렬 |
| data.nodes.id | 0_Chrome^_^login | String | 노드 ID |
| data.nodes.event_name | login | String | 노드 이벤트 이름 |
| data.nodes.by_value | Chrome | String | 노드 값 |
| data.nodes.times | 30301 | Integer | 횟수 |
| data.result_generate_time | 2022-01-24 18:53:26 | String | 조회 결과 생성 시간 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
2. 경로 분석 유저 목록
인터페이스 URL
/open/path-user-list?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"projectId": 0,
"eventView": {
"col_limit": 10,
"from_date": "2019-11-20 00:00:00",
"to_date": "2019-11-26 00:00:00",
"recent_day": "1-7",
"session_interval": 22,
"session_type": "minute"
},
"events": {
"event_names": [
"obtain_item",
"consume_item",
"obtain_coin"
],
"source_event": {
"event_name": "consume_item",
"filter": {
"filts": [
{
"columnName": "#os",
"comparator": "equal",
"ftv": [
"ios"
],
"tableType": "event"
}
],
"relation": "and"
}
},
"source_type": "initial_event",
"user_filter": {
"filts": [
{
"columnName": "user_level",
"comparator": "equal",
"ftv": [
"6"
],
"tableType": "user"
}
],
"relation": "and"
}
},
"next_slice_event_by_values": [
{
"slice_event_name": "obtain_coin"
}
],
"session_level": 2,
"slice_type": "with_next_specific",
"slice_event_by_values": [
{
"slice_event_name": "obtain_item"
}
],
"timeoutSeconds": 10,
"zoneOffset": 10
}
요청 파라미터 설명
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| projectId | 0 | String | 예 | 파라미터 설명 |
| eventView | - | Object | 예 | 경로 분석 조회 인터페이스와 파라미터 내용이 같음 |
| events | List | 예 | 이벤트 지표 목록 | |
| next_slice_event_by_values | - | List | 아니요 | 노드의 후속 이벤트 slice_type=with_next_specific일 때 필수 |
| next_slice_event_by_values.slice_event_name | obtain_coin | String | 아니요 | 이벤트 이름 |
| session_level | 2 | Integer | 예 | 노드가 위치한 경로 단계(0부터 계산) |
| slice_type | with_next_specific | String | 예 | 노드의 후속 이벤트 상황
|
| slice_event_by_values | - | List | 아니요 | 노드 이벤트 |
| slice_event_by_values.slice_event_name | obtain_item | String | 아니요 | 이벤트 이름 |
| timeoutSeconds | 10 | Integer | 아니요 | 요청 시간 초과 파라미터, 시간이 초과되면 쿼리 작업을 취소합니다 |
| zoneOffset | 10 | Integer | 아니요 | 시간대 |
성공 응답 예시
{
"data": {
"datalist": [
{
"#account_id": "j77444535",
"#distinct_id": "j143825535",
"user_level": 6,
"register_time": "2019-11-22 17:07:12",
"diamond_num": 1270,
"latest_login_time": "2019-11-22 18:23:19",
"channel": "app store",
"#user_id": 33190535
}
],
"total_num": 1,
"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 | 반환 정보 |
이 문서가 도움이 되었나요?

