대시보드 리포트 관리 API
호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.
관련 기능을 이해하려면 먼저 AE 사용 설명서의 데이터 대시보드 부분을 읽어 보시기를 권장합니다: 대시보드
1. 리포트 관리
1. Root 계정의 리포트 목록 조회
인터페이스 URL
/open/manage-reports?token=xxx&projectId=0
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
성공 응답 예시
{
"data": {
"reports": [
{
"createType": "MANUAL_CREATE",
"dashboardIds": [],
"reportDesc": "",
"reportId": 34214,
"reportModel": 0,
"reportName": "event_3의 총 횟수(4)",
"updateTime": "2021-02-04 16:44:03"
},
{
"createType": "IMPORTED",
"dashboardIds": [
3015
],
"reportDesc": "",
"reportId": 25565,
"reportModel": 0,
"reportName": "로그인 횟수-지난달(1)",
"updateTime": "2020-12-18 14:03:32"
}
],
"dashboards": [
{
"dashbord_id": 3015,
"dashbord_name": "성능 테스트"
}
]
},
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.dashboards | - | List | 대시보드 정보 |
| data.dashboards.dashbord_id | 1440 | Integer | 대시보드 ID |
| data.dashboards.dashbord_name | 조건 공통 필터 대시보드 | String | 대시보드 이름 |
| data.reports | - | List | 리포트 정보 |
| data.reports.createType | MANUAL_CREATE | String | 리포트 생성 방식:
|
| data.reports.dashboardIds | 2378 | Integer | 대시보드 ID 집합(이 리포트와 관련된 대시보드 ID 목록. 비어 있으면 이 리포트가 어떤 대시보드에도 없다는 뜻) |
| data.reports.reportDesc | - | Object | 리포트 주석 |
| data.reports.reportId | 4049 | Integer | 리포트 ID |
| data.reports.reportModel | 0 | Integer | 분석 모델
|
| data.reports.reportName | 직지 | String | 리포트 이름 |
| data.reports.updateTime | 2019-12-20 15:59:44 | Date | 업데이트 시간 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
2. 프로젝트 리포트 목록 조회
인터페이스 URL
/open/list-project-reports?token=xxx&projectId=0
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
성공 응답 예시
{
"data": [
{
"reportId": 34214,
"createType": "MANUAL_CREATE",
"reportDesc": "여기는 리포트 설명",
"projectId": 0,
"reportName": "여기는 리포트 이름",
"reportModel": "EVENT",
"creator": {
"openId": "UIODASBJ-Jiodas312",
"loginName": "user1",
"userName": "유저1"
},
"dashboardIds": [
109,
91
]
}
],
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 | |
|---|---|---|---|---|
| data | - | List | 반환 데이터 | |
| data.reportId | 34214 | Long | 리포트 ID | |
| data.reportName | 여기는 리포트 이름 | Integer | 리포트 이름 | |
| data.reportDesc | 여기는 리포트 설명 | String | 리포트 설명 | |
| data.projectId | 0 | Integer | 프로젝트 ID | |
data.createType | MANUAL_CREATE | String | 리포트 생성 방식:
| |
data.reportModel | EVENT | String |
| |
| data.creator | - | Object | 리포트 생성자 | |
| openId | UIODASBJ-Jiodas312 | String | openId | |
| loginName | user1 | String | 로그인 계정 | |
| userName | 유저1 | String | 닉네임 | |
| data.dashboardIds | [109, 91] | List | 대시보드 ID | |
| return_code | 0 | Integer | 반환 코드 | |
| return_message | success | String | 반환 정보 | |
3. 리포트 일괄 삭제
인터페이스 URL
/open/report-batch-del?token=xxx&projectId=0
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | String | 예 | 프로젝트 ID |
요청 Body 파라미터
{
"reportIds": [
34214
]
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| reportIds | [34214] | List | 아니요 | 리포트 ID 목록 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | String | 반환 코드 |
| return_message | success | String | 반환 정보 |
2. 대시보드 관리
4. 대시보드 리포트 관리/대시보드 가져오기
인터페이스 URL
/open/import-dashboards?token=xxx&projectId=0&dashboardNameConflictPolicy=RENAME_CREATE&spaceDashboardPolicy=IN_EXISTED_SPACE_OR_CREATE_SPACE
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| dashboardNameConflictPolicy | RENAME_CREATE | String | 예 | 대시보드 이름 충돌 전략, 기본값 RENAME_CREATE
|
| spaceDashboardPolicy | IN_EXISTED_SPACE_OR_CREATE_SPACE | String | 예 | 공유 공간의 대시보드 배치 전략, 기본값 IN_EXISTED_SPACE_OR_CREATE_SPACE
|
성공 응답 예시
{
"data": {
"boardCreateFailed": 1,
"boardCreated": 1,
"boardTotal": 2,
"folderCreated": 1,
"reportCreateFailed": 1,
"reportCreated": 1,
"reportTotal": 2
},
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.boardCreateFailed | 1 | Integer | 대시보드 생성 실패 수 |
| data.boardCreated | 1 | Integer | 대시보드 생성 성공 수 |
| data.boardTotal | 2 | Integer | 대시보드 총수 |
| data.folderCreated | 1 | Integer | 폴더 생성 수 |
| data.reportCreateFailed | 1 | Integer | 리포트 생성 실패 수 |
| data.reportCreated | 1 | Integer | 리포트 생성 수 |
| data.reportTotal | 2 | Integer | 리포트 총수 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -3004,
"return_message": "유효하지 않은 프로젝트"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -3004 | String | 반환 코드 |
| return_message | 유효하지 않은 프로젝트 | String | 반환 정보 |
5. 공간 대시보드 삭제
API 호출자가 생성한 대시보드이면 해당 대시보드를 삭제하고, 그렇지 않으면 대시보드를 공간에서 생성자의 비공개 디렉토리로 옮깁니다.
인터페이스 URL
/open/delete-dashboard-from-space?token=xxx&projectId=0&dashboardId=1&spaceId=1
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| dashboardId | 1 | Integer | 예 | 대시보드 ID |
| spaceId | 1 | Integer | 예 | 공간 ID |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터 오류, dashboard not in space"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터 오류, dashboard not in space | String | 반환 정보 |
3. 공간 관리
6. 공간 ID 및 대시보드 목록 조회
인터페이스 URL
/open/get-space-dashboards-by-space-name?token=xxx&projectId=377&spaceName=b
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 377 | Integer | 예 | 프로젝트 ID |
| spaceName | b | String | 예 | 공간 이름 |
성공 응답 예시
{
"data": {
"dashboards": [
{
"dashbordId": 3590,
"dashbordName": "lzm"
}
],
"spaceId": 31
},
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.dashboards | - | List | 대시보드 정보 |
| data.dashboards.dashbordId | 3590 | Integer | 대시보드 ID |
| data.dashboards.dashbordName | lzm | String | 대시보드 이름 |
| data.spaceId | 31 | Integer | 공간 ID |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1006,
"return_message": "작업 권한이 없습니다(view space dashboards)"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1006 | Integer | 반환 코드 |
| return_message | 작업 권한이 없습니다(view space dashboards) | String | 반환 정보 |
7. 공간 ID 및 멤버 권한 목록 조회
인터페이스 URL
/open/get-space-members-by-space-name?token=xxx&projectId=377&spaceName=b
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 377 | Integer | 예 | 프로젝트 ID |
| spaceName | b | String | 예 | 공간 이름 |
성공 응답 예시
{
"data": {
"allAuthUserAuthority": "MEMBER",
"authUserGroups": [
{
"authority": "ADMIN",
"id": 1301,
"name": "test1"
}
],
"authUsers": [
{
"authority": "ADMIN",
"id": 1149,
"name": "test2"
}
],
"creator": {
"id": 928,
"name": "test3"
},
"spaceId": 31
},
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.allAuthUserAuthority | MEMBER | String | 전체 인원 권한 |
| data.authUserGroups | - | List | 권한 그룹 목록 |
| data.authUserGroups.authority | ADMIN | String | 권한 |
| data.authUserGroups.id | 1301 | Integer | 유저 ID |
| data.authUserGroups.name | test1 | String | 유저 이름 |
| data.authUsers | - | List | 유저 목록 |
| data.authUsers.authority | ADMIN | String | 권한 |
| data.authUsers.id | 1149 | Integer | 유저 ID |
| data.authUsers.name | test2 | String | 유저 이름 |
| data.creator | - | Object | 생성자 정보 |
| data.creator.id | 928 | Integer | 생성자 유저 ID |
| data.creator.name | test3 | String | 생성자 이름 |
| data.spaceId | 31 | Integer | 공간 ID |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1006,
"return_message": "작업 권한이 없습니다(view space members)"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1006 | Integer | 반환 코드 |
| return_message | 작업 권한이 없습니다(view space members) | String | 반환 정보 |
8. 공간 멤버 권한 목록 업데이트
공간 이름과 공간 기본 권한을 업데이트하고, 공간 인원 권한이나 공간 멤버 그룹 권한을 추가 또는 수정하는 데 사용할 수 있습니다
제출한 멤버 권한 목록이 기존 멤버 목록 전체를 대체합니다
인터페이스 URL
/open/update-space?token=xxx&projectId=0&spaceId=0
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| spaceId | 0 | Integer | 예 | 공간 ID |
요청 Body 파라미터
{
"allAuthUserAuthority": "MEMBER",
"authUserGroups": [
{
"id": 99,
"authority": "MEMBER",
"name": "member99"
}
],
"authUsers": [
{
"id": 88,
"authority": "ADMIN",
"name": "admin88"
}
],
"spaceName": "spaceTest"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| allAuthUserAuthority | string | String | 아니요 | 전체 멤버 권한
|
| authUserGroups | - | List | 아니요 | 유저 그룹 목록 |
| authUserGroups.id | 99 | Integer | 아니요 | 유저 그룹 ID |
| authUserGroups.name | MEMBER | String | 아니요 | 유저 그룹 이름 |
| authUserGroups.authority | member99 | String | 아니요 | 유저 그룹 권한
|
| authUsers | - | List | 아니요 | 유저 목록 |
| authUsers.id | 88 | Integer | 아니요 | 유저 ID |
| authUsers.name | ADMIN | String | 아니요 | 유저 이름 |
| authUsers.authority | admin88 | String | 아니요 | 유저 권한
|
| spaceName | spaceTest | String | 아니요 | 공간 이름 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "대시보드 공간이 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | 대시보드 공간이 존재하지 않습니다 | String | 반환 정보 |
9. 공간 삭제
인터페이스 URL
/open/delete-space?token=xxx&projectId=0&spaceId=1
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| spaceId | 1 | Integer | 예 | 공간 ID |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "대시보드 공간이 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | 대시보드 공간이 존재하지 않습니다 | String | 반환 정보 |
4. 대시보드 푸시
10. 대시보드 푸시 실행
푸시 정보를 설정한 대시보드라면 정기 푸시 활성화 여부와 관계없이 모두 API로 푸시를 실행할 수 있으며, 화면에서 설정한 채널 내용과 스타일, 그리고 대시보드 생성자의 데이터 권한에 따라 즉시 푸시 작업을 실행합니다. 회사 수준, 프로젝트 수준 token만 사용할 수 있습니다.
인터페이스 URL
/open/dashboard/daily-report/exec
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| dashboardId | 1 | Integer | 예 | 대시보드 ID |
대시보드 푸시 API는 회사 수준, 프로젝트 수준 token만 사용할 수 있으며, 개인 수준 token은 지원하지 않습니다
성공 응답 예시
{"return_code": 0,"return_message": "success"}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{"return_code": -1,"return_message": "유효한 푸시 채널이 없습니다. 대시보드-대시보드 푸시에서 설정하십시오"}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1 | Integer | 반환 코드 |
| return_message | 유효한 푸시 채널이 없습니다. 대시보드-대시보드 푸시에서 설정하십시오 | String | 반환 정보 |

