manuallatest제품 매뉴얼 / 지표 조회 API
지표 조회 API
호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.
지표 관련 기능을 이해하려면 먼저 AE 사용 설명서를 읽어 보는 것을 권장합니다: 지표
1. 사용 가능한 지표 목록 조회
조건에 따라 지표 정의를 조회합니다
인터페이스 URL
/open/metric-list?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 body 파라미터 설명
{
"projectId": 102,
"metricName": "retention_1", //지표 이름-퍼지 매칭 지원
"metricDesc": "익일 리텐션", // 지표 표시-퍼지 매칭 지원
"metricModes": ["EVENT","RETENTION"], // 지표 생성 출처
"createUser":"root", //생성자
"updateUser":"root", //마지막 수정자
"timeParticleSize":"day" //지표가 지원하는 시간 단위
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| projectId | 102 | Integer | 예 | 프로젝트 ID |
| metricName | retention_1 | String | 아니요 | 지표 이름-퍼지 매칭 지원 |
| metricDesc | 익일 리텐션 | String | 아니요 | 지표 표시 이름-퍼지 매칭 지원 |
| metricModes | ["EVENT", "RETENTION"] | List | 아니요 | 지표 생성 출처 EVENT-이벤트 지표 RETENTION-리텐션 지표 |
| createUser | root | String | 아니요 | 지표 생성자 로그인 이름 |
| updateUser | root | String | 아니요 | 지표 수정자 로그인 이름 |
| timeParticle | day | String | 아니요 | 지표가 지원하는 시간 단위
|
응답 파라미터 설명
{
"data":
[
{
"metricId": 1,
"projectId": 2,
"metricName": "retention_1",
"metricDesc": "익일 리텐션",
"metricRemark": "가입 유저 익일 리텐션",
"metricMode": "EVENT",
"createUser": "root",
"updateUser": "root",
"createTime": "2022-12-12 10:10:00",
"updateTime": "2022-12-12 10:10:00",
"timeParticles":[ "minute"],
"format": "FORMAT_FLOAT"
}
],
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | 반환 결과 | |
| data.metricId | 1 | Long | 지표 Id |
| data.projectId | 102 | Integer | 지표가 속한 프로젝트 Id |
| data.metricName | retention_1 | String | 지표 이름 |
| data.metricDesc | 익일 리텐션 | String | 지표 표시 이름 |
| data.metricRemark | 가입 유저 익일 리텐션 | String | 지표 비고 |
| data.metricMode | RETENTION | String | 지표 생성 출처 |
| data.createUser | root | String | 지표 생성 유저 |
| data.updateUser | root | String | 지표 수정 유저 |
| data.createTime | 2022-12-12 10:10:00 | Date | 지표 생성일 |
| data.updateTime | 2022-12-12 10:10:00 | Date | 지표 수정일 |
| data.timeParticles | ['day', 'hour', 'month'] | List | 지표가 지원하는 시간 단위
|
| data.format | FORMAT_FLOAT | String | 지표 형식
|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
2. 지표 데이터 조회
인터페이스 URL
/open/metric-data?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"eventView": {
"comparedByTime": true,
"comparedStartTime": "2021-12-14 00:00:00",
"comparedEndTime": "2021-12-20 23:59:59",
"comparedRecentDay": "8-14",
"startTime": "2021-12-21 00:00:00",
"endTime": "2021-12-27 23:59:59",
"recentDay": "1-7",
"timeParticleSize": "day",
"groupBy": [{
"columnDesc": "브랜드",
"columnName": "brand",
"propertyRange": "",
"specifiedClusterDate": "2021-12-28",
"tableType": "event"
}],
"relation": "and",
"filts": [{
"columnDesc": "브랜드",
"columnName": "brand",
"comparator": "equal",
"filterType": "SIMPLE",
"ftv": ["Apple", "Xiaomi"],
"specifiedClusterDate": "2021-12-28",
"tableType": "event",
"timeUnit": ""
}],
"queryFeature": {
"approximateOn": true,
"globalQueryOn": false
}
},
"metrics":["retention_1","dau"],
"zoneOffset": 0,
"projectId": 377,
"useSameResultKey": false,
"useCache": true,
"limit": 1000,
"timeoutSeconds": 10
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| eventView | - | Object | 예 | 지표 공통 속성 부분 |
| eventView.comparedByTime | true | Boolean | 아니요 | 시간 비교 여부. TRUE: 예, FALSE: 아니요 |
eventView.comparedStartTime | 2021-12-14 00:00:00 | String | 아니요 | 비교 기간 시작 시간(형식: yyyy-MM-dd HH:mm:ss). 비교 기간 상대 시간이 비어 있을 때 유효 |
| eventView.comparedEndTime | 2021-12-20 23:59:59 | String | 아니요 | 비교 기간 종료 시간(형식: yyyy-MM-dd HH:mm:ss). 비교 기간 상대 시간이 비어 있을 때 유효 |
| eventView.comparedRecentDay | 8-14 | String | 아니요 | 비교 기간 상대 시간(comparedByTime이 TRUE이면 비교 기간 시작 시간, 비교 기간 종료 시간과 함께 모두 비워 둘 수 없음) |
| eventView.startTime | 2021-12-21 00:00:00 | String | 아니요 | 시작 시간(형식: yyyy-MM-dd HH:mm:ss). 상대 시간이 비어 있을 때 유효 |
| eventView.endTime | 2021-12-27 23:59:59 | String | 아니요 | 종료 시간(형식: yyyy-MM-dd HH:mm:ss). 상대 시간이 비어 있을 때 유효 |
| eventView.recentDay | 1-7 | String | 아니요 | 상대 시간(시작 시간, 종료 시간과 함께 모두 비워 둘 수 없음) |
| eventView.relation | and | String | 아니요 | 논리 관계. and: 논리곱, or: 논리합 |
eventView.timeParticleSize | day | String | 예 | 분석 시간 단위
|
| eventView.groupBy | - | List | 아니요 | 그룹 속성. 0개 이상 지정 가능 |
| eventView.groupBy.columnName | brand | String | 예 | 필드 이름 |
| eventView.groupBy.columnDesc | 브랜드 | String | 아니요 | 필드 표시 이름 |
| eventView.groupBy.propertyRange | String | 아니요 | 커스텀 속성 구간 | |
| eventView.groupBy.propertyRangeType | String | 아니요 | 속성 구간 유형. 숫자형 속성으로 그룹화할 때 커스텀 버킷 조건을 지정할 수 있음
| |
| eventView.groupBy.specifiedClusterDate | 2021-12-28 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| eventView.groupBy.tableType | event | String | 예 | 테이블 유형 열거형 값 |
| eventView.filts | - | List | 아니요 | 전체 필터 항목 |
| eventView.filts.columnDesc | 브랜드 | String | 아니요 | 필드 표시 이름 |
| eventView.filts.columnName | brand | String | 예 | 필드 이름 |
| eventView.filts.comparator | equal | String | 예 | 참고: 모델 조회 API의 필터 표현식 |
| eventView.filts.filterType | SIMPLE | String | 아니요 | 필터 모드. SIMPLE: 단순, COMPOUND: 복합. 기본값은 SIMPLE |
| eventView.filts.ftv | ["Apple", "Xiaomi"] | List | 아니요 | 속성 비교 경계에 사용하는 리터럴 상수 |
| eventView.filts.specifiedClusterDate | 2021-12-28 | String | 아니요 | 지정한 날짜에 해당하는 태그 이력 버전 |
| eventView.filts.tableType | event | String | 예 | 테이블 유형 열거형 값 |
| eventView.filts.timeUnit | String | 아니요 | 속성 비교 값 단위. relativeEvent*에만 유효: day, hour, minute | |
| eventView.queryFeature | - | Object | 아니요 | 조회 설정 |
| eventView.queryFeature.approximateOn | true | Boolean | 아니요 | 근사값 계산 사용 여부 |
| metrics | ["retention_1","dau"] | list | 예 | 지표 이름 목록 |
| projectId | 377 | Integer | 예 | 프로젝트 Id |
zoneOffset | 0 | Integer | 아니요 | 사용 시간대 |
| useCache | true | Boolean | 아니요 | 캐시 사용 여부, 선택 파라미터, 기본값 true |
| limit | 1000 | Integer | 아니요 | 분석 대상별 그룹 수 상한. 선택 파라미터이며 기본값은 1000, 최댓값은 10000 |
| timeoutSeconds | 10 | Integer | 아니요 | 요청 시간 초과 파라미터, 시간이 초과되면 쿼리 작업을 취소합니다 |
성공 응답 예시
{
"data": {
"result_generate_time": "2021-12-30 11:15:41",
"union_groups": [
[
"Safari",
"Apple"
],
[
"Firefox",
"Xiaomi"
],
[
"WeChat 내장 브라우저",
"Apple"
],
[
"전체",
"Apple"
],
[
"전체",
"Xiaomi"
]
],
"x": [
"2021-12-23",
"2021-12-24",
"2021-12-25",
"2021-12-26",
"2021-12-27",
"2021-12-28",
"2021-12-29"
],
"x_compared": [
"2021-12-16",
"2021-12-17",
"2021-12-18",
"2021-12-19",
"2021-12-20",
"2021-12-21",
"2021-12-22"
],
"y": [
{
"retention_1": [
{
"group_cols": [
"Safari",
"Apple"
],
"group_num": 3,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"447",
"980",
"1584",
"321",
"285",
"74",
"0"
]
},
{
"group_cols": [
"Firefox",
"Xiaomi"
],
"group_num": 3,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"291",
"818",
"1128",
"272",
"219",
"58",
"0"
]
},
{
"group_cols": [
"WeChat 내장 브라우저",
"Apple"
],
"group_num": 3,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"231",
"500",
"764",
"214",
"155",
"35",
"0"
]
}
]
},
{
"dau": [
{
"group_cols": [
"전체",
"Apple"
],
"group_num": 2,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"640",
"811",
"1251",
"1253",
"720",
"113",
"0"
]
},
{
"group_cols": [
"전체",
"Xiaomi"
],
"group_num": 2,
"values": [
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"values_compared": [
"277",
"439",
"600",
"666",
"364",
"59",
"0"
]
}
]
}
]
},
"return_code": 0,
"return_message": "success"
}
응답 파라미터 설명
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 결과 |
| data.result_generate_time | 2021-12-29 12:00:00 | String | 조회 결과 생성 시간 |
| data.union_groups | ["Apple"] | List | 모든 그룹 집합 |
| data.x | ["2021-12-23"] | List | X축 시간 |
| data.x_compared | ["2021-12-16"] | List | X축 비교 시간 |
| data.y | - | List | Y축 데이터 목록 |
| data.y.{지표 이름} | - | List | Y축 지표 정보 목록 |
| data.y.{지표 이름}.group_cols | ["Apple"] | List | Y축 지표 그룹 |
| data.y.{지표 이름}.group_num | 3 | Integer | Y축 지표 그룹 수 |
| data.y.{지표 이름}.values | ["0"] | List | Y축 지표 값 |
| data.y.{지표 이름}.values_compared | ["447"] | List | Y축 시간 비교 지표 값 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
이 문서가 도움이 되었나요?