Class Dashboard

A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

Hierarchy

  • Dashboard

Constructors

constructor

Properties

additionalProperties? authorHandle? authorName? createdAt? description? id? isReadOnly? layoutType modifiedAt? notifyList? reflowType? restrictedRoles? tags? templateVariablePresets? templateVariables? title url? widgets

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional authorHandle

authorHandle?: string

Identifier of the dashboard author.

Optional authorName

authorName?: string

Name of the dashboard author.

Optional createdAt

createdAt?: Date

Creation date of the dashboard.

Optional description

description?: string

Description of the dashboard.

Optional id

id?: string

ID of the dashboard.

Optional isReadOnly

isReadOnly?: boolean

Whether this dashboard is read-only. If True, only the author and admins can make changes to it.

This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.

layoutType

layoutType: DashboardLayoutType

Layout type of the dashboard.

Optional modifiedAt

modifiedAt?: Date

Modification date of the dashboard.

Optional notifyList

notifyList?: string[]

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

Optional reflowType

reflowType?: DashboardReflowType

Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.

Optional restrictedRoles

restrictedRoles?: string[]

A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.

This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.

Optional tags

tags?: string[]

List of team names representing ownership of a dashboard.

Optional templateVariablePresets

templateVariablePresets?: DashboardTemplateVariablePreset[]

Array of template variables saved views.

Optional templateVariables

templateVariables?: DashboardTemplateVariable[]

List of template variables for this dashboard.

title

title: string

Title of the dashboard.

Optional url

url?: string

The URL of the dashboard.

widgets

widgets: Widget[]

List of widgets to display on the dashboard.

Settings

Member Visibility

Theme

Generated using TypeDoc