Querying Dashboard Details

Function

This API is used to query dashboard details.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/aom/dashboards/{dashboard_id}

**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.
dashboard_id	Yes	String	Dashboard ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
version	Yes	String	Dashboard version.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
project_id	String	Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.
dashboard_type	String	Dashboard type.
dashboard_title	String	Dashboard name.
dashboard_title_en	String	Dashboard name.
dashboard_id	String	Dashboard ID.
version	String	Dashboard version.
enterprise_project_id	String	ID of the enterprise project to which the dashboard belongs. For details, see Obtaining an Enterprise Project ID.
folder_name	String	Dashboard group name.
folder_id	String	Dashboard group ID.
sync_data	String	Number of dashboards to be synchronized.
is_create_action	Boolean	Whether to add a dashboard. false: Update a dashboard. true: Add a dashboard. Enumeration values: true false
dashboard_tags	Array of Map<String,String> objects	Dashboard tag list.
is_favorite	Boolean	Whether to add the dashboard to favorites. true: Add a dashboard to favorites. false: Do not add a dashboard to favorites. Enumeration values: true false
created	Long	Time when the dashboard was created.
updated	Long	Time when the dashboard was updated.
created_by	String	Name of the account for adding the dashboard.
updated_by	String	Name of the account for updating the dashboard.
charts	Object	Dashboard graph details.
templating	Object	List of dashboard variables.
display	String	Display or not.
query_count	String	Total number of queries.
time_range	String	Default time range for query.

Example Requests

Query details about the dashboard whose ID is f80****4-03-4f-b9-b****f32ff.

https://{Endpoint}/v2/{project_id}/aom/dashboards/f80****4-0**3-4**f-b**9-b****f32f**f

Example Responses

Status code: 200

OK: The request is successful.

{
  "created" : 1719327521188,
  "updated" : 1719327521188,
  "templating" : { },
  "display" : true,
  "project_id" : "2a****56cc****7f83****891b****cf",
  "dashboard_type" : "dashboard",
  "dashboard_title" : "aom_dashboard",
  "dashboard_id" : "f80****4-0**3-4**f-b**9-b****f32f**f",
  "version" : "v1",
  "enterprise_project_id" : "0",
  "folder_name" : "Dashboard Group",
  "sync_data" : "{\"dashboard_id\":\"f80****4-0**3-4**f-b**9-b****f32f**f\",\"version\":\"v1\",\"folder_id\":null,\"is_create_action\":true}",
  "is_create_action" : false,
  "dashboard_tags" : [ { } ],
  "is_favorite" : false,
  "created_by" : "aom_ops_user2",
  "query_count" : 0
}