--- title: 대시보드 목록의 항목 얻기 description: 대시보드 목록의 대시보드 정의 불러오기. breadcrumbs: 문서 > API > 대시보드 목록의 항목 얻기 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # 대시보드 목록의 항목 얻기 ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | ### Overview 대시보드 목록의 대시보드 정의 불러오기. This endpoint requires the `dashboards_read` permission. OAuth apps require the `dashboards_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/ko/api/latest/scopes.md#dashboard-lists) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------------ | ------- | ------------------------------------------- | | dashboard_list_id [*required*] | integer | ID of the dashboard list to get items from. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Dashboards within a list. | Parent field | Field | Type | Description | | ------------ | ----------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | dashboards [*required*] | [object] | List of dashboards in the dashboard list. | | dashboards | author | object | Creator of the object. | | author | email | string | Email of the creator. | | author | handle | string | Handle of the creator. | | author | name | string | Name of the creator. | | dashboards | created | date-time | Date of creation of the dashboard. Read-only. | | dashboards | icon | string | URL to the icon of the dashboard. Read-only. | | dashboards | id [*required*] | string | ID of the dashboard. | | dashboards | integration_id | string | The short name of the integration. Read-only. | | dashboards | is_favorite | boolean | Whether or not the dashboard is in the favorites. Read-only. | | dashboards | is_read_only | boolean | Whether or not the dashboard is read only. Read-only. | | dashboards | is_shared | boolean | Whether the dashboard is publicly shared or not. Read-only. | | dashboards | modified | date-time | Date of last edition of the dashboard. Read-only. | | dashboards | popularity | int32 | Popularity of the dashboard. Read-only. | | dashboards | tags | [string] | List of team names representing ownership of a dashboard. Read-only. | | dashboards | title | string | Title of the dashboard. Read-only. | | dashboards | type [*required*] | enum | The type of the dashboard. Allowed enum values: `custom_timeboard`, `custom_screenboard`, `integration_screenboard`, `integration_timeboard`, `host_timeboard`. | | dashboards | url | string | URL path to the dashboard. Read-only. | | | total | int64 | Number of dashboards in the dashboard list. Read-only. | {% /tab %} {% tab label="Example" %} ```json { "dashboards": [ { "author": { "email": "string", "handle": "string", "name": "string" }, "created": "2019-09-19T10:00:00.000Z", "icon": "string", "id": "q5j-nti-fv6", "integration_id": "string", "is_favorite": false, "is_read_only": false, "is_shared": false, "modified": "2019-09-19T10:00:00.000Z", "popularity": "integer", "tags": [], "title": "string", "type": "host_timeboard", "url": "string" } ], "total": "integer" } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export dashboard_list_id="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/lists/manual/${dashboard_list_id}/dashboards" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get items of a Dashboard List returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "strconv" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "dashboard_list" in the system DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64) ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewDashboardListsApi(apiClient) resp, r, err := api.GetDashboardListItems(ctx, DashboardListID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.GetDashboardListItems`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.GetDashboardListItems`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get items of a Dashboard List returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.DashboardListsApi; import com.datadog.api.client.v2.model.DashboardListItems; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); DashboardListsApi apiInstance = new DashboardListsApi(defaultClient); // there is a valid "dashboard_list" in the system Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID")); try { DashboardListItems result = apiInstance.getDashboardListItems(DASHBOARD_LIST_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardListsApi#getDashboardListItems"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get items of a Dashboard List returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi # there is a valid "dashboard_list" in the system DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = DashboardListsApi(api_client) response = api_instance.get_dashboard_list_items( dashboard_list_id=int(DASHBOARD_LIST_ID), ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get items of a Dashboard List returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::DashboardListsAPI.new # there is a valid "dashboard_list" in the system DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"] p api_instance.get_dashboard_list_items(DASHBOARD_LIST_ID.to_i) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get items of a Dashboard List returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_dashboard_lists::DashboardListsAPI; #[tokio::main] async fn main() { // there is a valid "dashboard_list" in the system let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap(); let configuration = datadog::Configuration::new(); let api = DashboardListsAPI::with_config(configuration); let resp = api .get_dashboard_list_items(dashboard_list_id.clone()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get items of a Dashboard List returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.DashboardListsApi(configuration); // there is a valid "dashboard_list" in the system const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string); const params: v2.DashboardListsApiGetDashboardListItemsRequest = { dashboardListId: DASHBOARD_LIST_ID, }; apiInstance .getDashboardListItems(params) .then((data: v2.DashboardListItems) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% tab label="Python [legacy]" %} ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) api.DashboardList.v2.get_items(4741) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ``` {% /tab %} {% tab label="Ruby [legacy]" %} ```ruby require 'rubygems' require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) result = dog.v2.get_items_of_dashboard_list(4741) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ``` {% /tab %} {% /tabs %}