v1.Dashboard

v1.Dashboard.cross_filteringproperty

Whether cross filtering is enabled for this dashboard. Defaults to true.

cross_filtering?: boolean;

v1.Dashboard.descriptionproperty

An optional description of the dashboard.

description?: string;

v1.Dashboard.enable_section_headersproperty

Applies to the root layout. Whether all sections headers are enabled. Defaults to true.

enable_section_headers?: boolean;

v1.Dashboard.filter_viewsproperty

Whether user can save and apply filter views for this dashboard. Defaults to true.

filter_views?: boolean;

v1.Dashboard.filtersproperty

filters?: DashboardFilters;

v1.Dashboard.idproperty

id: Id9;

v1.Dashboard.permissionsproperty

Permissions for the dashboard

permissions?: {
        VIEW?: Permission;
        EDIT?: Permission;
        SHARE?: Permission;
    };

v1.Dashboard.persistent_filters_across_tabsproperty

Whether persistent filters across tabs are enabled for this dashboard. Defaults to true.

persistent_filters_across_tabs?: boolean;

v1.Dashboard.pluginsproperty

A list of plugins in this dashboard.

plugins?: ({
        id: Id15;
        parameters?: {
            [k: string]: unknown;
        } | unknown[] | string | number | boolean | null;
    } | Id16)[];

v1.Dashboard.sectionsproperty

A list of sections in this dashboard.

sections?: Section[];

v1.Dashboard.tabsproperty

A list of tabs in this dashboard. Each tab has its own layout, filters, and filter configurations. Mutually exclusive with sections and filters at dashboard level.

tabs?: Tab[];

v1.Dashboard.tagsproperty

tags?: Tags10;

v1.Dashboard.timezone_configproperty

timezone_config?: TimezoneConfig;

v1.Dashboard.titleproperty

An optional human readable title for the dashboard. Will be derived from id if not provided explicitly.

title?: string;

v1.Dashboard.typeproperty

type: "dashboard";

v1.Dashboard.user_filters_resetproperty

Whether user can reset custom updated filters. Defaults to true.

user_filters_reset?: boolean;

v1.Dashboard.user_filters_saveproperty

Whether user filter setting will be stored in local storage. Defaults to true.

user_filters_save?: boolean;

v1.Dashboard.versionproperty

Dashboard model version. “2” (default if omitted) — legacy shape: root-level sections/filters are also mirrored into a default tab, producing a declarative model with duplicated content for backward compatibility with older SDK readers. “3” — clean shape: tabs are the sole source of layout and filters; root sections/filters in YAML are still allowed as an authoring shortcut but are wrapped into a single synthetic tab without duplication. Use “3” for new dashboards; “2” exists to keep existing files round-trippable.

version?: "2" | "3";