Datadog Dashboard

Get dashboard details

Get a dashboard with widgets using the specified ID.

Inputs

Field

Type

Description

dashboard_id [required]

string

If you’re dynamically passing in a Dashboard using a variable, then ensure that you pass in a Dashboard ID value.

Outputs

Expand All

Field

Type

Description

url [required]

string

The URL of the dashboard.

id

string

ID of the dashboard.

title [required]

string

Title of the dashboard.

description

string

Description of the dashboard.

restricted_roles

[string]

A list of role identifiers.

created_at

date-time

Creation date of the dashboard.

modified_at

date-time

Modification date of the dashboard.

author_handle

string

Identifier of the dashboard author.

author_name

string

Name of the dashboard author.

layout_type [required]

enum

Layout type of the dashboard. Allowed enum values: ordered,free

reflow_type

enum

Reflow type for a new dashboard layout dashboard. Allowed enum values: auto,fixed

notify_list

[string]

List of handles of users to notify when changes are made to this dashboard.

tags

[string]

List of tags for this dashboard.

template_variables

[object]

List of template variables for this dashboard.

default

string

The default value for the template variable on dashboard load.

prefix

string

The tag prefix associated with the variable.

name [required]

string

The name of the variable.

available_values

[string]

The list of values that the template variable drop-down is limited to.

template_variable_presets

[object]

Array of template variables saved views.

name

string

The name of the variable.

template_variables

[object]

List of variables.

name

string

The name of the variable.

value

string

The value of the template variable within the saved view.

widgets [required]

[object]

List of widgets to display on the dashboard.

definition [required]

Definition of the widget.

layout

object

The layout for a widget on a free or new dashboard layout dashboard.

x [required]

number

The position of the widget on the x (horizontal) axis.

y [required]

number

The position of the widget on the y (vertical) axis.

height [required]

number

The height of the widget.

width [required]

number

The width of the widget.

is_column_break

boolean

Whether the widget should be the first one on the second column in high density or not.

id

number,string

ID of the widget.

is_read_only

boolean

Whether this dashboard is read-only.