> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# v1.Dashboard

- Package: [@gooddata/sdk-code-schemas](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-code-schemas/src/v1/metadata.ts

**Signature:**

```typescript
export interface Dashboard 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cross\_filtering?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardcross_filtering) |  | boolean | _(Optional)_ Whether cross filtering is enabled for this dashboard. Defaults to true. |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboarddescription) |  | string | _(Optional)_ An optional description of the dashboard. |
| [enable\_section\_headers?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardenable_section_headers) |  | boolean | _(Optional)_ Applies to the root layout. Whether all sections headers are enabled. Defaults to true. |
| [filter\_views?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardfilter_views) |  | boolean | _(Optional)_ Whether user can save and apply filter views for this dashboard. Defaults to true. |
| [filters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardfilters) |  | [DashboardFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardfilters/index.md) | _(Optional)_ |
| [id](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardid) |  | [Id9](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id9/index.md) |  |
| [permissions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardpermissions) |  | { VIEW?: [Permission](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.permission/index.md); EDIT?: [Permission](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.permission/index.md); SHARE?: [Permission](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.permission/index.md); } | _(Optional)_ Permissions for the dashboard |
| [persistent\_filters\_across\_tabs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardpersistent_filters_across_tabs) |  | boolean | _(Optional)_ Whether persistent filters across tabs are enabled for this dashboard. Defaults to true. |
| [plugins?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardplugins) |  | ({ id: [Id15](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id15/index.md); parameters?: { [k: string]: unknown; } \| unknown[] \| string \| number \| boolean \| null; } \| [Id16](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id16/index.md))[] | _(Optional)_ A list of plugins in this dashboard. |
| [sections?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardsections) |  | [Section](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.section/index.md)[] | _(Optional)_ A list of sections in this dashboard. |
| [tabs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardtabs) |  | [Tab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tab/index.md)[] | _(Optional)_ 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. |
| [tags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardtags) |  | [Tags10](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags10/index.md) | _(Optional)_ |
| [timezone\_config?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardtimezone_config) |  | [TimezoneConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.timezoneconfig/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardtitle) |  | string | _(Optional)_ An optional human readable title for the dashboard. Will be derived from id if not provided explicitly. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardtype) |  | "dashboard" |  |
| [user\_filters\_reset?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboarduser_filters_reset) |  | boolean | _(Optional)_ Whether user can reset custom updated filters. Defaults to true. |
| [user\_filters\_save?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboarduser_filters_save) |  | boolean | _(Optional)_ Whether user filter setting will be stored in local storage. Defaults to true. |
| [version?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboard/index.md#v1dashboardversion) |  | "2" \| "3" | _(Optional)_ 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. |

## Property details

### v1.Dashboard.cross_filtering

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

**Signature:**

```typescript
cross_filtering?: boolean;
```

### v1.Dashboard.description

An optional description of the dashboard.

**Signature:**

```typescript
description?: string;
```

### v1.Dashboard.enable_section_headers

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

**Signature:**

```typescript
enable_section_headers?: boolean;
```

### v1.Dashboard.filter_views

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

**Signature:**

```typescript
filter_views?: boolean;
```

### v1.Dashboard.filters

**Signature:**

```typescript
filters?: DashboardFilters;
```

### v1.Dashboard.id

**Signature:**

```typescript
id: Id9;
```

### v1.Dashboard.permissions

Permissions for the dashboard

**Signature:**

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

### v1.Dashboard.persistent_filters_across_tabs

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

**Signature:**

```typescript
persistent_filters_across_tabs?: boolean;
```

### v1.Dashboard.plugins

A list of plugins in this dashboard.

**Signature:**

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

### v1.Dashboard.sections

A list of sections in this dashboard.

**Signature:**

```typescript
sections?: Section[];
```

### v1.Dashboard.tabs

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.

**Signature:**

```typescript
tabs?: Tab[];
```

### v1.Dashboard.tags

**Signature:**

```typescript
tags?: Tags10;
```

### v1.Dashboard.timezone_config

**Signature:**

```typescript
timezone_config?: TimezoneConfig;
```

### v1.Dashboard.title

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

**Signature:**

```typescript
title?: string;
```

### v1.Dashboard.type

**Signature:**

```typescript
type: "dashboard";
```

### v1.Dashboard.user_filters_reset

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

**Signature:**

```typescript
user_filters_reset?: boolean;
```

### v1.Dashboard.user_filters_save

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

**Signature:**

```typescript
user_filters_save?: boolean;
```

### v1.Dashboard.version

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.

**Signature:**

```typescript
version?: "2" | "3";
```