Dashboards

Get all dashboards

Get all dashboards.

Note: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.

get/api/v1/dashboard

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/dashboard
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: dashboards_read

Query parameters

filter[shared]boolean

When true, this query only returns shared custom created or cloned dashboards.

filter[deleted]boolean

When true, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with filter[shared].

countinteger

The maximum number of dashboards returned in the list.

startinteger

The specific offset to use as the beginning of the returned response.

Response

OK

Example response

{
  "dashboards": [
    {
      "layout_type": "ordered"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.