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

# IWorkspaceDashboardsService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/dashboards/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Service to list, create and update analytical dashboards

**Signature:**

```typescript
export interface IWorkspaceDashboardsService 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [workspace](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceworkspace) | `readonly` | string | **_(ALPHA)_** |

## Methods

| Method | Description |
| --- | --- |
| [createDashboard(dashboard, generateId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicecreatedashboard) | **_(ALPHA)_** Create and save dashboard for the provided dashboard definition |
| [createDashboardPlugin(plugin)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicecreatedashboardplugin) | **_(ALPHA)_** Creates a record about a dashboard plugin. Creating a new dashboard plugin does not impact any existing dashboards in the workspace. In order to use a plugin on a dashboard, you need to create a link between the dashboard and the plugin. Multiple dashboards may link to a single plugin; each dashboard may link to the plugin with different plugin-specific parameters. |
| [createFilterView(filterView)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicecreatefilterview) | **_(ALPHA)_** Create a new filter view. |
| [createScheduledMail(scheduledMail, exportFilterContext)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicecreatescheduledmail) | **_(ALPHA)_** Create scheduled mail for the dashboard |
| [createWidgetAlert(alert)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicecreatewidgetalert) | **_(ALPHA)_** Create widget alert for the provided widget alert definition |
| [deleteDashboard(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicedeletedashboard) | **_(ALPHA)_** Delete dashboard |
| [deleteDashboardPlugin(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicedeletedashboardplugin) | **_(ALPHA)_** Deletes a record about a dashboard plugin from the backend. |
| [deleteFilterView(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicedeletefilterview) | **_(ALPHA)_** Delete a filter view identified by the provided ref. |
| [deleteScheduledMail(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicedeletescheduledmail) | **_(ALPHA)_** Delete scheduled mail |
| [deleteWidgetAlert(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicedeletewidgetalert) | **_(ALPHA)_** Delete widget alert with the given reference |
| [deleteWidgetAlerts(refs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicedeletewidgetalerts) | **_(ALPHA)_** Widget alerts bulk delete |
| [exportDashboardToCSVRaw(definition, fileName, customOverrides, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceexportdashboardtocsvraw) | **_(ALPHA)_** Export dashboard to CSV raw. CSV raw file is downloaded and attached as Blob data to the current window instance. |
| [exportDashboardToImage(ref, filters, filtersByTab, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceexportdashboardtoimage) | **_(ALPHA)_** Export dashboard to png. PNG file is downloaded and attached as Blob data to the current window instance. If title is not provided, the dashboard title will be fetched. |
| [exportDashboardToPdf(ref, filters, filtersByTab, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceexportdashboardtopdf) | **_(ALPHA)_** Export dashboard to pdf. You can override dashboard filters with custom filters. When no custom filters are set, the persisted dashboard filters will be used. PDF file is downloaded and attached as Blob data to the current window instance. |
| [exportDashboardToPresentation(ref, format, filters, filtersByTab, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceexportdashboardtopresentation) | **_(ALPHA)_** Export dashboard to pdf. You can override dashboard filters with custom filters. When no custom filters are set, the persisted dashboard filters will be used. PDF file is downloaded and attached as Blob data to the current window instance. |
| [exportDashboardToTabular(ref, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceexportdashboardtotabular) | **_(ALPHA)_** Export dashboard to tabular. Tabular file is downloaded and attached as Blob data to the current window instance. If title is not provided, the dashboard title will be fetched. |
| [getAllWidgetAlertsForCurrentUser()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetallwidgetalertsforcurrentuser) | **_(ALPHA)_** Get all widget alerts for the current user |
| [getDashboard(ref, filterContextRef, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboard) | **_(ALPHA)_** Load dashboard by its reference, and override filter context with the given custom filter context (custom filter context is used mainly for exporting) |
| [getDashboardPermissions(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardpermissions) | **_(ALPHA)_** Get current user's permissions to the dashboard. |
| [getDashboardPlugin(ref, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardplugin) | **_(ALPHA)_** Load dashboard plugin by it's reference. |
| [getDashboardPlugins(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardplugins) | **_(ALPHA)_** Gets all dashboard plugins registered in the current workspace. |
| [getDashboardReferencedObjects(dashboard, types)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardreferencedobjects) | **_(ALPHA)_** Get objects referenced by a given dashboard. |
| [getDashboards(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboards) | **_(ALPHA)_** Gets all dashboards available in current workspace. |
| [getDashboardsQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardsquery) | **_(ALPHA)_** List dashboards |
| [getDashboardSummaryWorkflowStatus(runId)?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardsummaryworkflowstatus) | **_(ALPHA)_** _(Optional)_ Gets the status of the dashboard summary workflow. Used for polling the status of the workflow run. |
| [getDashboardWidgetAlertsForCurrentUser(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardwidgetalertsforcurrentuser) | **_(ALPHA)_** Get all widget alerts for the current user for the given dashboard |
| [getDashboardWithReferences(ref, filterContextRef, options, types)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetdashboardwithreferences) | **_(ALPHA)_** Loads a dashboard and objects that the dashboard references. |
| [getExportDataByExportId(exportId, type, tabId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetexportdatabyexportid) | **_(ALPHA)_** Get the metadata stored with the export identified by the provided export id: the inlined filter context together with other export-render inputs (title, widget-title visibility, custom metadata and the explicit timezone). |
| [getFilterViewsForCurrentUser(dashboardRef)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetfilterviewsforcurrentuser) | **_(ALPHA)_** Get a list of filter views for the current user. |
| [getResolvedFiltersForWidget(widget, filters, attributeFilterConfigs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetresolvedfiltersforwidget) | **_(ALPHA)_** Takes a widget and a list of filters and returns filters that can be used for the widget. - for attribute filters, these are filters that should NOT be ignored according to the ignoreDashboardFilters property. - for date filters it is the last filter with the same date dimension as specified in dateDataSet property. DOES NOT SUPPORT MULTIPLE DATE FILTERS. If you want to provide multiple date filters, pls refer to getResolvedFiltersForWidgetWithMultipleDateFilters The implementation MUST take different ObjRef types into account, for example if an incoming filter uses idRef and an ignoreDashboardFilters item uses uriRef but they point to the same metadata object, the filter MUST NOT be included in the result. |
| [getResolvedFiltersForWidgetWithMultipleDateFilters(widget, commonDateFilters, otherFilters, attributeFilterConfigs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetresolvedfiltersforwidgetwithmultipledatefilters) | **_(ALPHA)_** Takes a widget, commonDateFilters and a list of other filters and returns filters that can be used for the widget. - common date filters are used only when match widget's date data set. If multiple of them match the last one is used - other date filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property. May have date data sets different from one in widget's definition - for attribute filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property. The implementation MUST take different ObjRef types into account, for example if an incoming filter uses idRef and an ignoreDashboardFilters item uses uriRef but they point to the same metadata object, the filter MUST NOT be included in the result. |
| [getScheduledMailsCountForDashboard(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetscheduledmailscountfordashboard) | **_(ALPHA)_** Get the number of scheduled emails for particular dashboard |
| [getScheduledMailsForDashboard(ref, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetscheduledmailsfordashboard) | **_(ALPHA)_** Get scheduled emails for particular dashboard |
| [getWidgetAlertsCountForWidgets(refs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetwidgetalertscountforwidgets) | **_(ALPHA)_** Get the number of widget alerts (created by any user) for particular widgets |
| [getWidgetReferencedObjects(widget, types)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicegetwidgetreferencedobjects) | **_(ALPHA)_** Get all metadata objects referenced by a given widget. |
| [setCertification(ref, certification)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicesetcertification) | **_(ALPHA)_** Sets dashboard certification metadata. |
| [setFilterViewAsDefault(ref, isDefault)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicesetfilterviewasdefault) | **_(ALPHA)_** Set a filter view identified by the provided ref as the default one. The other filter views for the same dashboard that are marked as default ones will be unmarked. |
| [startDashboardSummaryWorkflow(dashboardId)?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicestartdashboardsummaryworkflow) | **_(ALPHA)_** _(Optional)_ Starts the process of generating AI summary for the dashboard. |
| [updateDashboard(dashboard, updatedDashboard)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceupdatedashboard) | **_(ALPHA)_** Update dashboard |
| [updateDashboardMeta(updatedDashboard)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceupdatedashboardmeta) | **_(ALPHA)_** Patch dashboard |
| [updateScheduledMail(ref, scheduledMail, filterContextRef)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceupdatescheduledmail) | **_(ALPHA)_** Update existing scheduled mail for the dashboard |
| [updateWidgetAlert(alert)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsserviceupdatewidgetalert) | **_(ALPHA)_** Update widget alert |
| [validateDashboardsExistence(dashboardRefs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md#iworkspacedashboardsservicevalidatedashboardsexistence) | **_(ALPHA)_** Checks whether dashboards exist for current user. Returns sanitized array of existing dashboards according to user's permissions to access or drill to them. |

## Property details

### IWorkspaceDashboardsService.workspace

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
readonly workspace: string;
```

## Method details

### IWorkspaceDashboardsService.createDashboard()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Create and save dashboard for the provided dashboard definition

**Signature:**

```typescript
createDashboard(dashboard: IDashboardDefinition, generateId?: boolean): Promise<IDashboard>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dashboard | [IDashboardDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md) | dashboard definition |
| generateId | boolean | _(Optional)_ whether to generate a new identifier for the dashboard, default is true |

**Returns:**

Promise&lt;[IDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md)&gt;

promise of the created dashboard

### IWorkspaceDashboardsService.createDashboardPlugin()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Creates a record about a dashboard plugin. Creating a new dashboard plugin does not impact any existing dashboards in the workspace.

In order to use a plugin on a dashboard, you need to create a link between the dashboard and the plugin. Multiple dashboards may link to a single plugin; each dashboard may link to the plugin with different plugin-specific parameters.

**Signature:**

```typescript
createDashboardPlugin(plugin: IDashboardPluginDefinition): Promise<IDashboardPlugin>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| plugin | [IDashboardPluginDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardplugindefinition/index.md) | definition of plugin to create |

**Returns:**

Promise&lt;[IDashboardPlugin](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardplugin/index.md)&gt;

#### Remarks

Analytical Backend only allows creating new dashboard plugins or deleting existing plugins. The goal behind this decision is to encourage safe, phased rollout of new plugin versions. You must first create a new dashboard plugin and then explicitly start using this new version on dashboards in order for changes to take effect.

### IWorkspaceDashboardsService.createFilterView()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Create a new filter view.

**Signature:**

```typescript
createFilterView(filterView: IDashboardFilterViewSaveRequest): Promise<IDashboardFilterView>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| filterView | [IDashboardFilterViewSaveRequest](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardfilterviewsaverequest/index.md) | filter view that must be created. |

**Returns:**

Promise&lt;[IDashboardFilterView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardfilterview/index.md)&gt;

### IWorkspaceDashboardsService.createScheduledMail()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Create scheduled mail for the dashboard

**Signature:**

```typescript
createScheduledMail(scheduledMail: IScheduledMailDefinition, exportFilterContext?: IFilterContextDefinition): Promise<IScheduledMail>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| scheduledMail | [IScheduledMailDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmaildefinition/index.md) | scheduled email definition |
| exportFilterContext | [IFilterContextDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifiltercontextdefinition/index.md) | _(Optional)_ override dashboard filter context with the custom filter context during the export |

**Returns:**

Promise&lt;[IScheduledMail](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmail/index.md)&gt;

promise of the created scheduled email

### IWorkspaceDashboardsService.createWidgetAlert()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Create widget alert for the provided widget alert definition

**Signature:**

```typescript
createWidgetAlert(alert: IWidgetAlertDefinition): Promise<IWidgetAlert>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| alert | [IWidgetAlertDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertdefinition/index.md) | widget alert definition |

**Returns:**

Promise&lt;[IWidgetAlert](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalert/index.md)&gt;

promise with the created alert

### IWorkspaceDashboardsService.deleteDashboard()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete dashboard

**Signature:**

```typescript
deleteDashboard(ref: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceDashboardsService.deleteDashboardPlugin()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Deletes a record about a dashboard plugin from the backend.

**Signature:**

```typescript
deleteDashboardPlugin(ref: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | reference to plugin to |

**Returns:**

Promise&lt;void&gt;

#### Remarks

- some backend implementations may reject to delete a dashboard plugin that is used on existing dashboards

### IWorkspaceDashboardsService.deleteFilterView()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete a filter view identified by the provided ref.

**Signature:**

```typescript
deleteFilterView(ref: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | ref of the filter view that must be deleted. |

**Returns:**

Promise&lt;void&gt;

### IWorkspaceDashboardsService.deleteScheduledMail()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete scheduled mail

**Signature:**

```typescript
deleteScheduledMail(ref: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | scheduled email reference |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceDashboardsService.deleteWidgetAlert()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete widget alert with the given reference

**Signature:**

```typescript
deleteWidgetAlert(ref: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | widget alert reference |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceDashboardsService.deleteWidgetAlerts()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Widget alerts bulk delete

**Signature:**

```typescript
deleteWidgetAlerts(refs: ObjRef[]): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| refs | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | widget alerts references |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceDashboardsService.exportDashboardToCSVRaw()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Export dashboard to CSV raw.

CSV raw file is downloaded and attached as Blob data to the current window instance.

**Signature:**

```typescript
exportDashboardToCSVRaw(definition: IExecutionDefinition, fileName: string, customOverrides?: IRawExportCustomOverrides, options?: IDashboardExportRawOptions): Promise<IExportResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| definition | [IExecutionDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutiondefinition/index.md) | execution definition |
| fileName | string | name of the file |
| customOverrides | [IRawExportCustomOverrides](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.irawexportcustomoverrides/index.md) | _(Optional)_ custom title overrides for measures and display forms |
| options | [IDashboardExportRawOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportrawoptions/index.md) | _(Optional)_ export options |

**Returns:**

Promise&lt;[IExportResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportresult/index.md)&gt;

promise with object URL pointing to a Blob data of downloaded exported dashboard

### IWorkspaceDashboardsService.exportDashboardToImage()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Export dashboard to png.

PNG file is downloaded and attached as Blob data to the current window instance. If title is not provided, the dashboard title will be fetched.

**Signature:**

```typescript
exportDashboardToImage(ref: ObjRef, filters?: FilterContextItem[], filtersByTab?: FiltersByTab, options?: IDashboardExportImageOptions): Promise<IExportResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |
| filters | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | _(Optional)_ Override stored dashboard filters with custom filters |
| filtersByTab | [FiltersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.filtersbytab/index.md) | _(Optional)_ Override stored dashboard filters per tab with custom filters |
| options | [IDashboardExportImageOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportimageoptions/index.md) | _(Optional)_ export options |

**Returns:**

Promise&lt;[IExportResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportresult/index.md)&gt;

promise with object URL pointing to a Blob data of downloaded exported dashboard

### IWorkspaceDashboardsService.exportDashboardToPdf()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Export dashboard to pdf. You can override dashboard filters with custom filters. When no custom filters are set, the persisted dashboard filters will be used.

PDF file is downloaded and attached as Blob data to the current window instance.

**Signature:**

```typescript
exportDashboardToPdf(ref: ObjRef, filters?: FilterContextItem[], filtersByTab?: FiltersByTab, options?: IDashboardExportPdfOptions): Promise<IExportResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |
| filters | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | _(Optional)_ Override stored dashboard filters with custom filters |
| filtersByTab | [FiltersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.filtersbytab/index.md) | _(Optional)_ |
| options | [IDashboardExportPdfOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportpdfoptions/index.md) | _(Optional)_ export options |

**Returns:**

Promise&lt;[IExportResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportresult/index.md)&gt;

promise with object URL pointing to a Blob data of downloaded exported dashboard

### IWorkspaceDashboardsService.exportDashboardToPresentation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Export dashboard to pdf. You can override dashboard filters with custom filters. When no custom filters are set, the persisted dashboard filters will be used.

PDF file is downloaded and attached as Blob data to the current window instance.

**Signature:**

```typescript
exportDashboardToPresentation(ref: ObjRef, format: "PDF" | "PPTX", filters?: FilterContextItem[], filtersByTab?: FiltersByTab, options?: IDashboardExportPresentationOptions): Promise<IExportResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |
| format | "PDF" \| "PPTX" | export format |
| filters | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | _(Optional)_ Override stored dashboard filters with custom filters |
| filtersByTab | [FiltersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.filtersbytab/index.md) | _(Optional)_ Override stored dashboard filters per tab with custom filters |
| options | [IDashboardExportPresentationOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportpresentationoptions/index.md) | _(Optional)_ additional options |

**Returns:**

Promise&lt;[IExportResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportresult/index.md)&gt;

promise with object URL pointing to a Blob data of downloaded exported dashboard

### IWorkspaceDashboardsService.exportDashboardToTabular()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Export dashboard to tabular.

Tabular file is downloaded and attached as Blob data to the current window instance. If title is not provided, the dashboard title will be fetched.

**Signature:**

```typescript
exportDashboardToTabular(ref: ObjRef, options?: IDashboardExportTabularOptions): Promise<IExportResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |
| options | [IDashboardExportTabularOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md) | _(Optional)_ export options |

**Returns:**

Promise&lt;[IExportResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportresult/index.md)&gt;

promise with object URL pointing to a Blob data of downloaded exported dashboard

### IWorkspaceDashboardsService.getAllWidgetAlertsForCurrentUser()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get all widget alerts for the current user

**Signature:**

```typescript
getAllWidgetAlertsForCurrentUser(): Promise<IWidgetAlert[]>;
```
**Returns:**

Promise&lt;[IWidgetAlert](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalert/index.md)[]&gt;

promise with all user widget alerts

### IWorkspaceDashboardsService.getDashboard()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Load dashboard by its reference, and override filter context with the given custom filter context (custom filter context is used mainly for exporting)

**Signature:**

```typescript
getDashboard(ref: ObjRef, filterContextRef?: ObjRef, options?: IGetDashboardOptions): Promise<IDashboard>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard ref |
| filterContextRef | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | _(Optional)_ Override dashboard filter context with the custom filter context (This allows to modify filter context when exporting the dashboard) |
| options | [IGetDashboardOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md) | _(Optional)_ Specify additional options |

**Returns:**

Promise&lt;[IDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md)&gt;

promise of the dashboard

### IWorkspaceDashboardsService.getDashboardPermissions()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get current user's permissions to the dashboard.

**Signature:**

```typescript
getDashboardPermissions(ref: ObjRef): Promise<IDashboardPermissions>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |

**Returns:**

Promise&lt;[IDashboardPermissions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardpermissions/index.md)&gt;

### IWorkspaceDashboardsService.getDashboardPlugin()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Load dashboard plugin by it's reference.

**Signature:**

```typescript
getDashboardPlugin(ref: ObjRef, options?: IGetDashboardPluginOptions): Promise<IDashboardPlugin>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | plugin reference |
| options | [IGetDashboardPluginOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardpluginoptions/index.md) | _(Optional)_ options that specify how the plugin should be loaded |

**Returns:**

Promise&lt;[IDashboardPlugin](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardplugin/index.md)&gt;

### IWorkspaceDashboardsService.getDashboardPlugins()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Gets all dashboard plugins registered in the current workspace.

**Signature:**

```typescript
getDashboardPlugins(options?: IGetDashboardPluginOptions): Promise<IDashboardPlugin[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IGetDashboardPluginOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardpluginoptions/index.md) | _(Optional)_ options that specify how the plugin should be loaded |

**Returns:**

Promise&lt;[IDashboardPlugin](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardplugin/index.md)[]&gt;

### IWorkspaceDashboardsService.getDashboardReferencedObjects()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get objects referenced by a given dashboard.

**Signature:**

```typescript
getDashboardReferencedObjects(dashboard: IDashboard, types?: SupportedDashboardReferenceTypes[]): Promise<IDashboardReferences>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dashboard | [IDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md) | dashboard to get referenced objects for |
| types | [SupportedDashboardReferenceTypes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.supporteddashboardreferencetypes/index.md)[] | _(Optional)_ optional array of object types to include, when not specified, all supported references will be retrieved |

**Returns:**

Promise&lt;[IDashboardReferences](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardreferences/index.md)&gt;

### IWorkspaceDashboardsService.getDashboards()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Gets all dashboards available in current workspace.

**Signature:**

```typescript
getDashboards(options?: IGetDashboardOptions): Promise<IListedDashboard[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IGetDashboardOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md) | _(Optional)_ Specify additional options |

**Returns:**

Promise&lt;[IListedDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ilisteddashboard/index.md)[]&gt;

promise of list of the dashboards

### IWorkspaceDashboardsService.getDashboardsQuery()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

List dashboards

**Signature:**

```typescript
getDashboardsQuery(): IDashboardsQuery;
```
**Returns:**

[IDashboardsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardsquery/index.md)

methods for querying dashboards

### IWorkspaceDashboardsService.getDashboardSummaryWorkflowStatus()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Gets the status of the dashboard summary workflow. Used for polling the status of the workflow run.

**Signature:**

```typescript
getDashboardSummaryWorkflowStatus?(runId: string): Promise<IDashboardSummaryWorkflowStatusResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| runId | string | id of the workflow run |

**Returns:**

Promise&lt;IDashboardSummaryWorkflowStatusResult&gt;

### IWorkspaceDashboardsService.getDashboardWidgetAlertsForCurrentUser()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get all widget alerts for the current user for the given dashboard

**Signature:**

```typescript
getDashboardWidgetAlertsForCurrentUser(ref: ObjRef): Promise<IWidgetAlert[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |

**Returns:**

Promise&lt;[IWidgetAlert](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalert/index.md)[]&gt;

promise with all user widget alerts for the dashboard

### IWorkspaceDashboardsService.getDashboardWithReferences()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Loads a dashboard and objects that the dashboard references.

**Signature:**

```typescript
getDashboardWithReferences(ref: ObjRef, filterContextRef?: ObjRef, options?: IGetDashboardOptions, types?: SupportedDashboardReferenceTypes[]): Promise<IDashboardWithReferences>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard ref |
| filterContextRef | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | _(Optional)_ Override dashboard filter context with the custom filter context (This allows to modify filter context when exporting the dashboard) |
| options | [IGetDashboardOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md) | _(Optional)_ Specify additional options |
| types | [SupportedDashboardReferenceTypes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.supporteddashboardreferencetypes/index.md)[] | _(Optional)_ types of dashboard references to load; if the types are undefined, the service must default to loading insights related to the dashboard |

**Returns:**

Promise&lt;[IDashboardWithReferences](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardwithreferences/index.md)&gt;

promise of the dashboard and references

### IWorkspaceDashboardsService.getExportDataByExportId()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get the metadata stored with the export identified by the provided export id: the inlined filter context together with other export-render inputs (title, widget-title visibility, custom metadata and the explicit timezone).

**Signature:**

```typescript
getExportDataByExportId(exportId: string, type: "visual" | "slides" | undefined, tabId?: string): Promise<{
        filterContext?: IFilterContext;
        title?: string;
        hideWidgetTitles?: boolean;
        exportMetadata?: Record<string, string>;
        timezoneId?: string;
    } | null>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| exportId | string | export id |
| type | "visual" \| "slides" \| undefined | export type |
| tabId | string | _(Optional)_ id of the tab to export |

**Returns:**

Promise&lt;{ filterContext?: [IFilterContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifiltercontext/index.md); title?: string; hideWidgetTitles?: boolean; exportMetadata?: Record&lt;string, string&gt;; timezoneId?: string; } &#124; null&gt;

#### Remarks

The timezone is present only when it cannot be derived at export time (an ad-hoc view-mode override or a resolved browser-detected timezone); otherwise the dashboard's own stored timezone applies.

### IWorkspaceDashboardsService.getFilterViewsForCurrentUser()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get a list of filter views for the current user.

**Signature:**

```typescript
getFilterViewsForCurrentUser(dashboardRef: ObjRef): Promise<IDashboardFilterView[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dashboardRef | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | ref of the dashboard for which we want to get the filter views. |

**Returns:**

Promise&lt;[IDashboardFilterView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardfilterview/index.md)[]&gt;

### IWorkspaceDashboardsService.getResolvedFiltersForWidget()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Takes a widget and a list of filters and returns filters that can be used for the widget. - for attribute filters, these are filters that should NOT be ignored according to the ignoreDashboardFilters property. - for date filters it is the last filter with the same date dimension as specified in dateDataSet property. DOES NOT SUPPORT MULTIPLE DATE FILTERS. If you want to provide multiple date filters, pls refer to getResolvedFiltersForWidgetWithMultipleDateFilters

The implementation MUST take different ObjRef types into account, for example if an incoming filter uses idRef and an ignoreDashboardFilters item uses uriRef but they point to the same metadata object, the filter MUST NOT be included in the result.

**Signature:**

```typescript
getResolvedFiltersForWidget(widget: IWidget, filters: IFilter[], attributeFilterConfigs: IDashboardAttributeFilterConfig[]): Promise<IFilter[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| widget | [IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) | widget to get filters for |
| filters | [IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[] | filters to apply on the widget |
| attributeFilterConfigs | [IDashboardAttributeFilterConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardattributefilterconfig/index.md)[] | filter configs |

**Returns:**

Promise&lt;[IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[]&gt;

promise with the filters with the ignored filters removed

### IWorkspaceDashboardsService.getResolvedFiltersForWidgetWithMultipleDateFilters()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Takes a widget, commonDateFilters and a list of other filters and returns filters that can be used for the widget. - common date filters are used only when match widget's date data set. If multiple of them match the last one is used - other date filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property. May have date data sets different from one in widget's definition - for attribute filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property.

The implementation MUST take different ObjRef types into account, for example if an incoming filter uses idRef and an ignoreDashboardFilters item uses uriRef but they point to the same metadata object, the filter MUST NOT be included in the result.

**Signature:**

```typescript
getResolvedFiltersForWidgetWithMultipleDateFilters(widget: IWidget, commonDateFilters: IDateFilter[], otherFilters: IFilter[], attributeFilterConfigs: IDashboardAttributeFilterConfig[]): Promise<IFilter[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| widget | [IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) | widget to get filters for |
| commonDateFilters | [IDateFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatefilter/index.md)[] | date filters to apply on the widget only when matching its date dataSet |
| otherFilters | [IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[] | filters to apply on the widget |
| attributeFilterConfigs | [IDashboardAttributeFilterConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardattributefilterconfig/index.md)[] | filter configs |

**Returns:**

Promise&lt;[IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[]&gt;

promise with the filters with the ignored filters removed

### IWorkspaceDashboardsService.getScheduledMailsCountForDashboard()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get the number of scheduled emails for particular dashboard

**Signature:**

```typescript
getScheduledMailsCountForDashboard(ref: ObjRef): Promise<number>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |

**Returns:**

Promise&lt;number&gt;

promise with the number of scheduled emails connected to the dashboard

### IWorkspaceDashboardsService.getScheduledMailsForDashboard()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get scheduled emails for particular dashboard

**Signature:**

```typescript
getScheduledMailsForDashboard(ref: ObjRef, options?: IGetScheduledMailOptions): Promise<IScheduledMail[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |
| options | [IGetScheduledMailOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetscheduledmailoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

Promise&lt;[IScheduledMail](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmail/index.md)[]&gt;

promise with scheduled emails connected to the dashboard

### IWorkspaceDashboardsService.getWidgetAlertsCountForWidgets()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get the number of widget alerts (created by any user) for particular widgets

**Signature:**

```typescript
getWidgetAlertsCountForWidgets(refs: ObjRef[]): Promise<IWidgetAlertCount[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| refs | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | widget references |

**Returns:**

Promise&lt;[IWidgetAlertCount](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iwidgetalertcount/index.md)[]&gt;

promise with array of pairs of widget ref and alert count

### IWorkspaceDashboardsService.getWidgetReferencedObjects()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get all metadata objects referenced by a given widget.

**Signature:**

```typescript
getWidgetReferencedObjects(widget: IWidget, types?: SupportedWidgetReferenceTypes[]): Promise<IWidgetReferences>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| widget | [IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) | widget to get referenced objects for |
| types | [SupportedWidgetReferenceTypes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.supportedwidgetreferencetypes/index.md)[] | _(Optional)_ optional array of object types to include, when not specified, all supported references will be retrieved |

**Returns:**

Promise&lt;[IWidgetReferences](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iwidgetreferences/index.md)&gt;

### IWorkspaceDashboardsService.setCertification()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets dashboard certification metadata.

**Signature:**

```typescript
setCertification(ref: ObjRef, certification?: IObjectCertificationWrite): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dashboard reference |
| certification | IObjectCertificationWrite | _(Optional)_ certification state; undefined clears certification |

**Returns:**

Promise&lt;void&gt;

### IWorkspaceDashboardsService.setFilterViewAsDefault()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Set a filter view identified by the provided ref as the default one. The other filter views for the same dashboard that are marked as default ones will be unmarked.

**Signature:**

```typescript
setFilterViewAsDefault(ref: ObjRef, isDefault: boolean): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | ref of the filter view that must be set as default. |
| isDefault | boolean | determine if filter view identified by the provided ref should be marked as a default one. If yes, any existing filter view for the same user and dashboard will be marked as non default as only one can be set as default at the same time. |

**Returns:**

Promise&lt;void&gt;

### IWorkspaceDashboardsService.startDashboardSummaryWorkflow()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Starts the process of generating AI summary for the dashboard.

**Signature:**

```typescript
startDashboardSummaryWorkflow?(dashboardId: string): Promise<IDashboardSummaryWorkflowStartResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dashboardId | string | id of the dashboard for which summary should be generated |

**Returns:**

Promise&lt;IDashboardSummaryWorkflowStartResult&gt;

### IWorkspaceDashboardsService.updateDashboard()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Update dashboard

**Signature:**

```typescript
updateDashboard(dashboard: IDashboard, updatedDashboard: IDashboardDefinition): Promise<IDashboard>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dashboard | [IDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md) | original dashboard before modifications |
| updatedDashboard | [IDashboardDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md) | modified dashboard |

**Returns:**

Promise&lt;[IDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md)&gt;

promise of the updated dashboard

### IWorkspaceDashboardsService.updateDashboardMeta()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Patch dashboard

**Signature:**

```typescript
updateDashboardMeta(updatedDashboard: IDashboardObjectIdentity & Partial<IDashboardBase>): Promise<IDashboard>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| updatedDashboard | [IDashboardObjectIdentity](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardobjectidentity/index.md) &amp; Partial&lt;[IDashboardBase](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardbase/index.md)&gt; | modified dashboard |

**Returns:**

Promise&lt;[IDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md)&gt;

promise of the updated dashboard

### IWorkspaceDashboardsService.updateScheduledMail()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Update existing scheduled mail for the dashboard

**Signature:**

```typescript
updateScheduledMail(ref: ObjRef, scheduledMail: IScheduledMailDefinition, filterContextRef?: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | reference to the existing scheduled email object |
| scheduledMail | [IScheduledMailDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ischeduledmaildefinition/index.md) | scheduled email definition |
| filterContextRef | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | _(Optional)_ optional reference to an existing filter context to be used in all attachments |

**Returns:**

Promise&lt;void&gt;

promise of the updated scheduled email

### IWorkspaceDashboardsService.updateWidgetAlert()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Update widget alert

**Signature:**

```typescript
updateWidgetAlert(alert: IWidgetAlert | IWidgetAlertDefinition): Promise<IWidgetAlert>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| alert | [IWidgetAlert](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalert/index.md) \| [IWidgetAlertDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertdefinition/index.md) | updated widget alert |

**Returns:**

Promise&lt;[IWidgetAlert](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalert/index.md)&gt;

promise with the updated alert

### IWorkspaceDashboardsService.validateDashboardsExistence()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Checks whether dashboards exist for current user. Returns sanitized array of existing dashboards according to user's permissions to access or drill to them.

**Signature:**

```typescript
validateDashboardsExistence(dashboardRefs: ObjRef[]): Promise<IExistingDashboard[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dashboardRefs | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | dashboard references to validate |

**Returns:**

Promise&lt;[IExistingDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexistingdashboard/index.md)[]&gt;