# 대시보드 & 리포트 관리 API

호출 방법의 사용에 대해서는 Open API 문서의 호출 방법 설명을 확인하십시오.

관련 기능을 이해하려면 TA 사용자 가이드의 데이터 대시보드 섹션을 읽는 것이 좋습니다: 대시보드

# 1. 리포트 관리

# Root 관리자의 문의 리포트 목록

인터페이스 URL

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

요청 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	0	Integer	Yes	Project ID

성공적인 응답 예시

{
  "data": {
    "reports": [
      {
        "createType": "MANUAL_CREATE",
        "dashboardIds": [],
        "reportDesc": "",
        "reportId": 34214,
        "reportModel": 0,
        "reportName": "event_3 total number(4)",
        "updateTime": "2021-02-04 16:44:03"
      },
      {
        "createType": "IMPORTED",
        "dashboardIds": [
          3015
        ],
        "reportDesc": "",
        "reportId": 25565,
        "reportModel": 0,
        "reportName": "Login times - last month(1)",
        "updateTime": "2020-12-18 14:03:32"
      }
    ],
    "dashboards": [
      {
        "dashbord_id": 3015,
        "dashbord_name": "performance test"
      }
    ]
  },
  "return_code": 0,
  "return_message": "success"
}

$$Parameter name	Sample value	Parameter type	Parameter description
data	-	Object	Return data
data.dashboards	-	List	Dashboard Information
data.dashboards.dashbord_id	1440	Integer	Dashboard ID
data.dashboards.dashbord_name	Conditional Universal Screening Dashboard	String	Dashboard name
data.reports	-	List	Report Information
data.reports.createType	MANUAL_CREATE	String	Report creation method Enum: MANUAL_CREATE: create manually IMPORTED: Dashboard import COPIED: Dashboard copy
data.reports.dashboardIds	2378	Integer	Dashboard ID collection (the list of Dashboard IDs related to the report, Empty indicates that the report is not on any Dashboard)
data.reports.reportDesc	-	Object	Report Notes
data.reports.reportId	4049	Integer	Report ID
data.reports.reportModel	0	Integer	Analysis model 0: Event analysis 1: Retention analysis 2: Funnel analysis 3: User analysis 4: Flow analysis 5: Distribution analysis
data.reports.reportName	Pointing	String	Report name
data.reports.updateTime	2019-12-20 15:59:44	Date	Update time
return_code	0	Integer	Return code
return_message	success	String	Return information

# 프로젝트의 리포트 목록 검색

인터페이스 URL

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

요청 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	0	Integer	Yes	Project ID

성공적인 응답 예시

{
    "data": [
        {
            "reportId": 34214,
            "createType": "MANUAL_CREATE",
            "reportDesc": "This is Report description",
            "projectId": 0,
            "reportName": "This is Report name",
            "reportModel": "EVENT",
            "creator": {
                "openId": "UIODASBJ-Jiodas312",
                "loginName": "user1",
                "userName": "User1"
            },
            "dashboardIds": [
                109,
                91
            ]
        }
    ],
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name		Sample value	Parameter type
data	-	List	Returned data
data.reportId	34214	Long	Report ID
data.reportName	This is Report name	Integer	Report Name
data.reportDesc	This is Report description	String	Report Description
data.projectId	0	Integer	Project ID
data.createType	MANUAL_CREATE	String	Method of Report Creation MANUAL_CREATE: Created manually IMPORTED: Created by importing COPIED: Created by copying SCENE_CREATE: Created based on Templates PACK_IMPORT: Created by project importing
data.reportModel	EVENT	String	EVENT: Event Reports RETENTION: Retention Reports FUNNEL: Funnel Reports PROP_ANALYSIS: Composition Reports PATH_ANALYSIS: Flows Reports SQL: SQL Reports INTERVAL_ANALYSIS: Interval Reports
data.creator	-	Object	Reports Creator
openId	UIODASBJ-Jiodas312	String	Open ID
loginName	user1	String	Login Account
userName	User1	String	Nickname
data.dashboardIds	[109, 91]	List	Dashboard ID
return_code	0	Integer	Return code
return_message	success	String	Return information

# 리포트 일괄 삭제

인터페이스 URL

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

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	0	String	Yes	Project ID

응답 본문 파라미터

{
    "reportIds": [
        34214
    ]
}

Parameter name	Sample value	Parameter type	Is required	Parameter description
Reports	[34214]	List	No	List of report IDs

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	0	String	Return code
return_message	success	String	Return information

# 2. 대시보드 관리

# 대시보드 리포트 관리/대시보드 가져오기

인터페이스 URL

/open/import-dashboards?token=xxx&projectId=0&dashboardNameConflictPolicy=RENAME_CREATE&spaceDashboardPolicy=IN_EXISTED_SPACE_OR_CREATE_SPACE

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	0	Integer	Yes	Project ID
dashboardNameConflictPolicy	RENAME_CREATE	String	Yes	Dashboard name conflict policy, default value RENAME_CREATE, RENAME_CREATE: automatic name change SKIP: Skip REPLACE: Replace
spaceDashboardPolicy	IN_EXISTED_SPACE_OR_CREATE_SPACE	String	Yes	Dashboard placement strategy for shared space, default value IN_EXISTED_SPACE_OR_CREATE_SPACE CREATE_SPACE: put dashboard in the newly created space IN_EXISTED_SPACE_OR_CREATE_SPACE: put Dashboard in an existing space with the same name or in a newly created space IN_PRIVATE: Put it under my dashboard

성공적인 응답 예시

{
    "data": {
        "boardCreateFailed": 1,
        "boardCreated": 1,
        "boardTotal": 2,
        "folderCreated": 1,
        "reportCreateFailed": 1,
        "reportCreated": 1,
        "reportTotal": 2
    },
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name	Sample value	Parameter type	Parameter description
data	-	Object	Return data
data.boardCreateFailed	1	Integer	Number of Dashboard creation failures
data.boardCreated	1	Integer	Number of successful Dashboard creation
data.boardTotal	2	Integer	Total Dashboard
data.folderCreated	1	Integer	Number of folders created
data.reportCreateFailed	1	Integer	Number of report creation failures
data.reportCreated	1	Integer	Number of reports created
data.reportTotal	2	Integer	Total number of statements
return_code	0	Integer	Return code
return_message	success	String	Return information

오류 응답 예시

{
    "return_code": -3004,
    "return_message": "invalid item"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	-3004	String	Return code
return_message	Invalid item	String	Return information

# 공간 대시보드 삭제

::: 팁

대시보드가 API 호출자에 의해 생성되었다면 삭제하고, 그렇지 않다면 대시보드를 공간에서 생성자의 개인 디렉토리로 이동합니다.

인터페이스 URL

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

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	0	Integer	Yes	Project ID
dashboardId	1	Integer	Yes	Dashboard ID
spaceId	1	Integer	Yes	Space ID

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	0	Integer	Return code
return_message	success	String	Return information

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "parameter error，dashboard not in space"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	-1008	Integer	Return code
return_message	Parameter error, dashboard not in space	String	Return information

# 3. 공간 관리

# 공간 ID 및 대시보드 목록 조회

인터페이스 URL

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

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	377	Integer	Yes	Project ID
spaceName	b	String	Yes	Space name

성공적인 응답 예시

{
    "data": {
        "dashboards": [
            {
                "dashbordId": 3590,
                "dashbordName": "lzm"
            }
        ],
        "spaceId": 31
    },
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name	Sample value	Parameter type	Parameter description
data	-	Object	Return data
data.dashboards	-	List	Dashboard Information
data.dashboards.dashbordId	3590	Integer	Dashboard ID
data.dashboards.dashbordName	lzm	String	Dashboard name
data.spaceId	31	Integer	Space ID
return_code	0	Integer	Return code
return_message	success	String	Return information

오류 응답 예시

{
    "return_code": -1006,
    "return_message": "You do not have permission to operate(view space dashboards)"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	-1006	Integer	Return code
return_message	You do not have permission to operate (view space dashboards)	String	Return information

# 공간 ID 및 구성원 권한 목록 조회

인터페이스 URL

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

요청 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	377	Integer	Yes	Project ID
spaceName	b	String	Yes	Space name

성공적인 응답 예시

{
    "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"
}

$$Parameter name	Sample value	Parameter type	Parameter description
data	-	Object	Return data
data.allAuthUserAuthority	MEMBER	String	All staff permissions
data.authUserGroups	-	List	Permission group list
data.authUserGroups.authority	ADMIN	String	Permissions
data.authUserGroups.id	1301	Integer	User ID
data.authUserGroups.name	test1	String	User name
data.authUsers	-	List	User list
data.authUsers.authority	ADMIN	String	Permissions
data.authUsers.id	1149	Integer	User ID
data.authUsers.name	test2	String	User name
data.creator	-	Object	Creator information
data.creator.id	928	Integer	Creator user ID
data.creator.name	test3	String	Creator name
data.spaceId	31	Integer	Space ID
return_code	0	Integer	Return code
return_message	success	String	Return information

오류 응답 예시

{
    "return_code": -1006,
    "return_message": "You do not have permission to operate(view space members)"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	-1006	Integer	Return code
return_message	You do not have permission to operate (view space members)	String	Return information

# 공간 구성원 권한 목록 업데이트

공간 이름, 공간 기본 권한 업데이트, 공간 구성원 권한 추가 또는 수정, 공간 구성원 그룹 권한 추가 또는 수정 등에 사용할 수 있습니다.

::: 팁

제출된 구성원 권한 목록은 원래의 구성원 목록을 전체적으로 대체할 것입니다.

:::

인터페이스 URL

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

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	0	Integer	Yes	Project ID
spaceId	0	Integer	Yes	Space ID

응답 본문 파라미터

{
  "allAuthUserAuthority": "MEMBER",
  "authUserGroups": [
    {
      "id": 99,
      "authority": "MEMBER",
      "name": "member99"
    }
  ],
  "authUsers": [
    {
      "id": 88,
      "authority": "ADMIN",
      "name": "admin88"
    }
  ],
  "spaceName": "spaceTest"
}

$$Parameter name	Sample value	Parameter type	Is required	Parameter description
allAuthUserAuthority	string	String	No	Full member permissions MEMBER: Ordinary member ADMIN: Administrator
authUserGroups	-	List	No	Field display name
authUserGroups.id	99	Integer	No	User group ID
authUserGroups.name	MEMBER	String	No	User group name
authUserGroups.authority	member99	String	No	User group permissions MEMBER: Ordinary Member ADMIN: Administrator
authUsers	-	List	No	Field description
authUsers.id	88	Integer	No	User ID
authUsers.name	ADMIN	String	No	User name
authUsers.authority	admin88	String	No	User permissions MEMBER: Ordinary member ADMIN: Administrator
spaceName	spaceTest	String	No	Space name

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	0	Integer	Return code
return_message	success	String	Return information

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "dashboard space does not exist"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	-1023	Integer	Return code
return_message	Dashboard space does not exist	String	Return information

# 공간 삭제

인터페이스 URL

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

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name	Sample value	Parameter type	Is required	Parameter description
token	xxx	String	Yes	token
projectId	0	Integer	Yes	Project ID
spaceId	1	Integer	Yes	Space ID

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	0	Integer	Return code
return_message	success	String	Return information

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "dashboard space does not exist"
}

Parameter name	Sample value	Parameter type	Parameter description
return_code	-1023	Integer	Return code
return_message	Dashboard space does not exist	String	Return information

#

← 메타데이터 관리 API 사용자 관리 API →