Help Center/Application Operations Management/API Reference/APIs/Dashboard/Querying the Dashboard Group List
Updated on 2025-11-06 GMT+08:00
View PDF

Querying the Dashboard Group List

Function

This API is used to query the dashboard group list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/aom/dashboards-folder

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM. For details, see Obtaining a Token.

Content-Type

No

String

Message body type or format. Content type, which is application/json.

Enterprise-Project-Id

No

String

Enterprise project ID. For details, see Obtaining an Enterprise Project ID.

  • To query the instances in an enterprise project, enter the enterprise project ID.

  • To query the instances in all enterprise projects, enter all_granted_eps.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of DashBoardsFolder objects

Dashboard group list.

Table 4 DashBoardsFolder

Parameter

Type

Description

created

Long

Time when the dashboard group was created.

updated

Long

Time when the dashboard group was modified.

created_by

String

Account that created the dashboard group.

dashboard_ids

Array of strings

List of dashboard IDs in the dashboard group.

display

Boolean

Whether to display the dashboard group.

enterprise_project_id

String

Enterprise project ID. For details, see Obtaining an Enterprise Project ID.

folder_id

String

Dashboard group ID.

folder_title

String

Dashboard group name.

folder_title_en

String

Dashboard group name.

is_template

Boolean

Whether the dashboard group is the default one.

Example Requests

Query the dashboard group list.

https://{Endpoint}/v2/{project_id}/aom/dashboards-folder

Example Responses

Status code: 200

OK: The request is successful.

[ {
  "created" : 1712474334896,
  "dashboard_ids" : [ "07994ceb-****-****-****-1e****3d****" ],
  "display" : true,
  "enterprise_project_id" : "0",
  "folder_id" : "16ea61ea-**-****-****-cd****a3190a",
  "folder_title" : "Dashboard",
  "folder_title_en" : "Historical Dashboards",
  "is_template" : false,
  "updated" : 0
} ]

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.

Parent topic:Dashboard