본문으로 건너뛰기

대시보드 리포트 관리 API

최근 업데이트 2026. 10. 03.

호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.

관련 기능을 이해하려면 먼저 AE 사용 설명서의 데이터 대시보드 부분을 읽어 보시기를 권장합니다: 대시보드

1. 리포트 관리​

1. Root 계정의 리포트 목록 조회​

인터페이스 URL

/open/manage-reports?token=xxx&projectId=0

요청 방식

GET

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 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_id1440Integer대시보드 ID
data.dashboards.dashbord_name조건 공통 필터 대시보드String대시보드 이름
data.reports-List리포트 정보
data.reports.createTypeMANUAL_CREATEString

리포트 생성 방식:

  • MANUAL_CREATE: 수동 생성
  • IMPORTED: 대시보드 가져오기로 생성
  • COPIED: 대시보드 복사로 생성
data.reports.dashboardIds2378Integer대시보드 ID 집합(이 리포트와 관련된 대시보드 ID 목록. 비어 있으면 이 리포트가 어떤 대시보드에도 없다는 뜻)
data.reports.reportDesc-Object리포트 주석
data.reports.reportId4049Integer리포트 ID
data.reports.reportModel0Integer

분석 모델

  • 0: 이벤트 분석
  • 1: 리텐션 분석
  • 2: 퍼널 분석
  • 3: 유저 속성 분석
  • 4: 경로 분석
  • 5: 분포 분석
data.reports.reportName직지String리포트 이름
data.reports.updateTime2019-12-20 15:59:44Date업데이트 시간
return_code0Integer반환 코드
return_messagesuccessString반환 정보

2. 프로젝트 리포트 목록 조회​

인터페이스 URL

/open/list-project-reports?token=xxx&projectId=0

요청 방식

GET

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 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.reportId34214Long리포트 ID
data.reportName여기는 리포트 이름Integer리포트 이름
data.reportDesc여기는 리포트 설명String리포트 설명
data.projectId0Integer프로젝트 ID

data.createType

MANUAL_CREATEString

리포트 생성 방식:

  • MANUAL_CREATE: 수동 생성
  • IMPORTED: 가져오기로 생성
  • COPIED: 복사로 생성
  • SCENE_CREATE 템플릿 기반 생성
  • PACK_IMPORT 프로젝트 가져오기로 생성

data.reportModel

EVENT

String
  • EVENT: 이벤트 분석 리포트
  • RETENTION: 리텐션 분석 리포트
  • FUNNEL: 퍼널 분석 리포트
  • PROP_ANALYSIS: 속성 분석 리포트
  • PATH_ANALYSIS: 경로 분석 리포트
  • SQL: SQL 리포트
  • INTERVAL_ANALYSIS: 간격 분석 리포트
data.creator-Object리포트 생성자
openIdUIODASBJ-Jiodas312StringopenId
loginNameuser1String로그인 계정
userName유저1String닉네임
data.dashboardIds[109, 91]List대시보드 ID
return_code0Integer반환 코드
return_messagesuccessString반환 정보

3. 리포트 일괄 삭제​

인터페이스 URL

/open/report-batch-del?token=xxx&projectId=0

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0String예프로젝트 ID

요청 Body 파라미터

{
"reportIds": [
34214
]
}
파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
reportIds[34214]List아니요리포트 ID 목록

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0String반환 코드
return_messagesuccessString반환 정보

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 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
dashboardNameConflictPolicyRENAME_CREATEString예

대시보드 이름 충돌 전략, 기본값 RENAME_CREATE

  • RENAME_CREATE: 자동 이름 변경
  • SKIP: 건너뛰기
  • REPLACE: 교체
spaceDashboardPolicyIN_EXISTED_SPACE_OR_CREATE_SPACEString예

공유 공간의 대시보드 배치 전략, 기본값 IN_EXISTED_SPACE_OR_CREATE_SPACE

  • CREATE_SPACE: 새로 생성한 공간에 대시보드를 배치
  • IN_EXISTED_SPACE_OR_CREATE_SPACE: 이미 있는 같은 이름의 공간 또는 새로 생성한 공간에 대시보드를 배치
  • IN_PRIVATE: 내 대시보드 아래에 배치

성공 응답 예시

{
"data": {
"boardCreateFailed": 1,
"boardCreated": 1,
"boardTotal": 2,
"folderCreated": 1,
"reportCreateFailed": 1,
"reportCreated": 1,
"reportTotal": 2
},
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
data-Object반환 데이터
data.boardCreateFailed1Integer대시보드 생성 실패 수
data.boardCreated1Integer대시보드 생성 성공 수
data.boardTotal2Integer대시보드 총수
data.folderCreated1Integer폴더 생성 수
data.reportCreateFailed1Integer리포트 생성 실패 수
data.reportCreated1Integer리포트 생성 수
data.reportTotal2Integer리포트 총수
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -3004,
"return_message": "유효하지 않은 프로젝트"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-3004String반환 코드
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 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
dashboardId1Integer예대시보드 ID
spaceId1Integer예공간 ID

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1008,
"return_message": "파라미터 오류, dashboard not in space"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1008Integer반환 코드
return_message파라미터 오류, dashboard not in spaceString반환 정보

3. 공간 관리​

6. 공간 ID 및 대시보드 목록 조회​

인터페이스 URL

/open/get-space-dashboards-by-space-name?token=xxx&projectId=377&spaceName=b

요청 방식

GET

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId377Integer예프로젝트 ID
spaceNamebString예공간 이름

성공 응답 예시

{
"data": {
"dashboards": [
{
"dashbordId": 3590,
"dashbordName": "lzm"
}
],
"spaceId": 31
},
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
data-Object반환 데이터
data.dashboards-List대시보드 정보
data.dashboards.dashbordId3590Integer대시보드 ID
data.dashboards.dashbordNamelzmString대시보드 이름
data.spaceId31Integer공간 ID
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1006,
"return_message": "작업 권한이 없습니다(view space dashboards)"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1006Integer반환 코드
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 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId377Integer예프로젝트 ID
spaceNamebString예공간 이름

성공 응답 예시

{
"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.allAuthUserAuthorityMEMBERString전체 인원 권한
data.authUserGroups-List권한 그룹 목록
data.authUserGroups.authorityADMINString권한
data.authUserGroups.id1301Integer유저 ID
data.authUserGroups.nametest1String유저 이름
data.authUsers-List유저 목록
data.authUsers.authorityADMINString권한
data.authUsers.id1149Integer유저 ID
data.authUsers.nametest2String유저 이름
data.creator-Object생성자 정보
data.creator.id928Integer생성자 유저 ID
data.creator.nametest3String생성자 이름
data.spaceId31Integer공간 ID
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1006,
"return_message": "작업 권한이 없습니다(view space members)"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1006Integer반환 코드
return_message작업 권한이 없습니다(view space members)String반환 정보

8. 공간 멤버 권한 목록 업데이트​

공간 이름과 공간 기본 권한을 업데이트하고, 공간 인원 권한이나 공간 멤버 그룹 권한을 추가 또는 수정하는 데 사용할 수 있습니다

주의

제출한 멤버 권한 목록이 기존 멤버 목록 전체를 대체합니다

인터페이스 URL

/open/update-space?token=xxx&projectId=0&spaceId=0

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
spaceId0Integer예공간 ID

요청 Body 파라미터

{
"allAuthUserAuthority": "MEMBER",
"authUserGroups": [
{
"id": 99,
"authority": "MEMBER",
"name": "member99"
}
],
"authUsers": [
{
"id": 88,
"authority": "ADMIN",
"name": "admin88"
}
],
"spaceName": "spaceTest"
}
파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
allAuthUserAuthoritystringString

아니요

전체 멤버 권한

  • MEMBER: 일반 멤버
  • ADMIN: 관리자
authUserGroups-List아니요유저 그룹 목록
authUserGroups.id99Integer아니요유저 그룹 ID
authUserGroups.nameMEMBERString아니요유저 그룹 이름
authUserGroups.authority

member99

String

아니요

유저 그룹 권한

  • MEMBER: 일반 멤버
  • ADMIN: 관리자
authUsers-List아니요유저 목록
authUsers.id88Integer아니요유저 ID
authUsers.nameADMINString아니요유저 이름
authUsers.authorityadmin88String아니요

유저 권한

  • MEMBER: 일반 멤버
  • ADMIN: 관리자
spaceNamespaceTestString아니요공간 이름

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1023,
"return_message": "대시보드 공간이 존재하지 않습니다"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1023Integer반환 코드
return_message대시보드 공간이 존재하지 않습니다String반환 정보

9. 공간 삭제​

인터페이스 URL

/open/delete-space?token=xxx&projectId=0&spaceId=1

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
spaceId1Integer예공간 ID

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1023,
"return_message": "대시보드 공간이 존재하지 않습니다"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1023Integer반환 코드
return_message대시보드 공간이 존재하지 않습니다String반환 정보

4. 대시보드 푸시​

10. 대시보드 푸시 실행​

푸시 정보를 설정한 대시보드라면 정기 푸시 활성화 여부와 관계없이 모두 API로 푸시를 실행할 수 있으며, 화면에서 설정한 채널 내용과 스타일, 그리고 대시보드 생성자의 데이터 권한에 따라 즉시 푸시 작업을 실행합니다. 회사 수준, 프로젝트 수준 token만 사용할 수 있습니다.

인터페이스 URL

/open/dashboard/daily-report/exec

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
dashboardId1Integer예대시보드 ID
token 유형 제한

대시보드 푸시 API는 회사 수준, 프로젝트 수준 token만 사용할 수 있으며, 개인 수준 token은 지원하지 않습니다

성공 응답 예시

{"return_code": 0,"return_message": "success"}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{"return_code": -1,"return_message": "유효한 푸시 채널이 없습니다. 대시보드-대시보드 푸시에서 설정하십시오"}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1Integer반환 코드
return_message유효한 푸시 채널이 없습니다. 대시보드-대시보드 푸시에서 설정하십시오String반환 정보
이 문서가 도움이 되었나요?