Dashboard and report management API

Last updated 10/03/2026

For how to call the API, see the calling method described in the Open API document.

We recommend reading the dashboard section of the AE user manual first to learn about the related features: Dashboard

1. Report management

1. Query the report list of the Root account

Endpoint URL

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

Request method

GET

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	Integer	Yes	Project ID

Success response example

{
  "data": {
    "reports": [
      {
        "createType": "MANUAL_CREATE",
        "dashboardIds": [],
        "reportDesc": "",
        "reportId": 34214,
        "reportModel": 0,
        "reportName": "Total count of event_3(4)",
        "updateTime": "2021-02-04 16:44:03"
      },
      {
        "createType": "IMPORTED",
        "dashboardIds": [
          3015
        ],
        "reportDesc": "",
        "reportId": 25565,
        "reportModel": 0,
        "reportName": "Login count - 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	Example value	Parameter type	Description
data	-	Object	Returned data
data.dashboards	-	List	Dashboard information
data.dashboards.dashbord_id	1440	Integer	Dashboard ID
data.dashboards.dashbord_name	General condition filter dashboard	String	Dashboard name
data.reports	-	List	Report information
data.reports.createType	MANUAL_CREATE	String	Report creation method: MANUAL_CREATE: Created manually IMPORTED: Created by dashboard import COPIED: Created by dashboard copy
data.reports.dashboardIds	2378	Integer	Dashboard ID set (list of dashboard IDs related to the report; empty means the report isn't on any dashboard)
data.reports.reportDesc	-	Object	Report comment
data.reports.reportId	4049	Integer	Report ID
data.reports.reportModel	0	Integer	Analysis model 0: Events Analysis 1: Retention Analysis 2: Funnel Analysis 3: Composition Analysis (user properties) 4: Flows Analysis 5: Distribution Analysis
data.reports.reportName	Zhizhi	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 message

2. Query the project report list

Endpoint URL

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

Request method

GET

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	Integer	Yes	Project ID

Success response example

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

Parameter name	Example value	Parameter type	Description
data	-	List	Returned data
data.reportId	34214	Long	Report ID
data.reportName	Report name here	Integer	Report name
data.reportDesc	Report description here	String	Report description
data.projectId	0	Integer	Project ID
data.createType	MANUAL_CREATE	String	Report creation method: MANUAL_CREATE: Created manually IMPORTED: Created by import COPIED: Created by copy SCENE_CREATE Created from a template PACK_IMPORT Created by project import
data.reportModel	EVENT	String	EVENT: Events Analysis report RETENTION: Retention Analysis report FUNNEL: Funnel Analysis report PROP_ANALYSIS: Composition Analysis report PATH_ANALYSIS: Flows Analysis report SQL: SQL report INTERVAL_ANALYSIS: Interval Analysis report
data.creator	-	Object	Report creator
openId	UIODASBJ-Jiodas312	String	openId
loginName	user1	String	Login account
userName	User 1	String	Nickname
data.dashboardIds	[109, 91]	List	Dashboard ID
return_code	0	Integer	Return code
return_message	success	String	Return message

3. Batch delete reports

Endpoint URL

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

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	String	Yes	Project ID

Request body parameters

{
    "reportIds": [
        34214
    ]
}

Parameter name	Example value	Parameter type	Required	Description
reportIds	[34214]	List	No	Report ID list

Success response example

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

Parameter name	Example value	Parameter type	Description
return_code	0	String	Return code
return_message	success	String	Return message

2. Dashboard management

4. Dashboard and report management/Import dashboards

Endpoint URL

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

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	Integer	Yes	Project ID
dashboardNameConflictPolicy	RENAME_CREATE	String	Yes	Strategy for dashboard name conflicts, RENAME_CREATE by default RENAME_CREATE: Rename automatically SKIP: Skip REPLACE: Replace
spaceDashboardPolicy	IN_EXISTED_SPACE_OR_CREATE_SPACE	String	Yes	Placement strategy for dashboards in shared spaces, IN_EXISTED_SPACE_OR_CREATE_SPACE by default CREATE_SPACE: Place dashboards in a newly created space IN_EXISTED_SPACE_OR_CREATE_SPACE: Place dashboards in an existing space with the same name, or in a newly created space IN_PRIVATE: Place dashboards under My Dashboards

Success response example

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

Parameter name	Example value	Parameter type	Description
data	-	Object	Returned data
data.boardCreateFailed	1	Integer	Number of dashboards that failed to be created
data.boardCreated	1	Integer	Number of dashboards created successfully
data.boardTotal	2	Integer	Total dashboards
data.folderCreated	1	Integer	Number of folders created
data.reportCreateFailed	1	Integer	Number of reports that failed to be created
data.reportCreated	1	Integer	Number of reports created
data.reportTotal	2	Integer	Total reports
return_code	0	Integer	Return code
return_message	success	String	Return message

Error response example

{
    "return_code": -3004,
    "return_message": "Invalid project"
}

Parameter name	Example value	Parameter type	Description
return_code	-3004	String	Return code
return_message	Invalid project	String	Return message

5. Delete a space dashboard

Note

If the dashboard was created by the API caller, the dashboard is deleted. Otherwise, the dashboard is moved from the space to the creator's private directory.

Endpoint URL

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

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	Integer	Yes	Project ID
dashboardId	1	Integer	Yes	Dashboard ID
spaceId	1	Integer	Yes	Space ID

Success response example

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

Parameter name	Example value	Parameter type	Description
return_code	0	Integer	Return code
return_message	success	String	Return message

Error response example

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

Parameter name	Example value	Parameter type	Description
return_code	-1008	Integer	Return code
return_message	Parameter error, dashboard not in space	String	Return message

3. Space management

6. Query space IDs and dashboard lists

Endpoint URL

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

Request method

GET

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	377	Integer	Yes	Project ID
spaceName	b	String	Yes	Space name

Success response example

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

Parameter name	Example value	Parameter type	Description
data	-	Object	Returned 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 message

Error response example

{
    "return_code": -1006,
    "return_message": "You don't have permission for this operation (view space dashboards)"
}

Parameter name	Example value	Parameter type	Description
return_code	-1006	Integer	Return code
return_message	You don't have permission for this operation (view space dashboards)	String	Return message

7. Query space IDs and member permission lists

Endpoint URL

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

Request method

GET

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	377	Integer	Yes	Project ID
spaceName	b	String	Yes	Space name

Success response example

{
    "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	Example value	Parameter type	Description
data	-	Object	Returned data
data.allAuthUserAuthority	MEMBER	String	All-member permission
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 message

Error response example

{
    "return_code": -1006,
    "return_message": "You don't have permission for this operation (view space members)"
}

Parameter name	Example value	Parameter type	Description
return_code	-1006	Integer	Return code
return_message	You don't have permission for this operation (view space members)	String	Return message

8. Update the space member permission list

Use this to update the space name and default space permission, add or modify permissions of space members, and add or modify permissions of space member groups

Note

The submitted member permission list replaces the original member list entirely

Endpoint URL

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

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	Integer	Yes	Project ID
spaceId	0	Integer	Yes	Space ID

Request body parameters

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

Parameter name	Example value	Parameter type	Required	Description
allAuthUserAuthority	string	String	No	Permission for all members MEMBER: Member ADMIN: Admin
authUserGroups	-	List	No	User group list
authUserGroups.id	99	Integer	No	User group ID
authUserGroups.name	MEMBER	String	No	User group name
authUserGroups.authority	member99	String	No	User group permission MEMBER: Member ADMIN: Admin
authUsers	-	List	No	User list
authUsers.id	88	Integer	No	User ID
authUsers.name	ADMIN	String	No	User name
authUsers.authority	admin88	String	No	User permission MEMBER: Member ADMIN: Admin
spaceName	spaceTest	String	No	Space name

Success response example

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

Parameter name	Example value	Parameter type	Description
return_code	0	Integer	Return code
return_message	success	String	Return message

Error response example

{
    "return_code": -1023,
    "return_message": "Dashboard space doesn't exist"
}

Parameter name	Example value	Parameter type	Description
return_code	-1023	Integer	Return code
return_message	Dashboard space doesn't exist	String	Return message

9. Delete a space

Endpoint URL

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

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	Integer	Yes	Project ID
spaceId	1	Integer	Yes	Space ID

Success response example

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

Parameter name	Example value	Parameter type	Description
return_code	0	Integer	Return code
return_message	success	String	Return message

Error response example

{
    "return_code": -1023,
    "return_message": "Dashboard space doesn't exist"
}

Parameter name	Example value	Parameter type	Description
return_code	-1023	Integer	Return code
return_message	Dashboard space doesn't exist	String	Return message

4. Dashboard digest

10. Send a dashboard digest

Any dashboard with push settings configured supports sending a push via API, whether or not scheduled push is turned on. The push task runs immediately with the channel content and style configured in the UI and the data permissions of the dashboard creator. Only company-level and project-level tokens are supported.

Endpoint URL

/open/dashboard/daily-report/exec

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
dashboardId	1	Integer	Yes	Dashboard ID

Token type restrictions

Only company-level and project-level tokens can use the dashboard digest API. Personal tokens aren't supported

Success response example

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

Parameter name	Example value	Parameter type	Description
return_code	0	Integer	Return code
return_message	success	String	Return message

Error response example

{"return_code": -1,"return_message": "No valid push channel. Go to Dashboard - Send Digest to configure it"}

Parameter name	Example value	Parameter type	Description
return_code	-1	Integer	Return code
return_message	No valid push channel. Go to Dashboard - Send Digest to configure it	String	Return message

Was this page helpful?

1. Report management​

1. Query the report list of the Root account​

2. Query the project report list​

3. Batch delete reports​

2. Dashboard management​

4. Dashboard and report management/Import dashboards​

5. Delete a space dashboard​

3. Space management​

6. Query space IDs and dashboard lists​

7. Query space IDs and member permission lists​

8. Update the space member permission list​

9. Delete a space​

4. Dashboard digest​

10. Send a dashboard digest​

1. Report management

1. Query the report list of the Root account

2. Query the project report list

3. Batch delete reports

2. Dashboard management

4. Dashboard and report management/Import dashboards

5. Delete a space dashboard

3. Space management

6. Query space IDs and dashboard lists

7. Query space IDs and member permission lists

8. Update the space member permission list

9. Delete a space

4. Dashboard digest

10. Send a dashboard digest