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

# IGetDashboardOptions

- 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).
> 

Configuration options for getting dashboards.

**Signature:**

```typescript
export interface IGetDashboardOptions 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [exportId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md#igetdashboardoptionsexportid) |  | string | **_(ALPHA)_** _(Optional)_ Specify id of the currently performed dashboard pdf export. This id is used to retrieve export-related metadata, such as currently active attribute filters. The id is missing when the dashboard is not loaded in the export mode |
| [exportTabId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md#igetdashboardoptionsexporttabid) |  | string | **_(ALPHA)_** _(Optional)_ Tab identifier to export. Used for export of dashboard with tabs. |
| [exportType?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md#igetdashboardoptionsexporttype) |  | "visual" \| "slides" | **_(ALPHA)_** _(Optional)_ Specify type of the currently performed dashboard export. This id is used to retrieve export-related metadata, such as currently active attribute filters. |
| [includeAvailableViaLink?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md#igetdashboardoptionsincludeavailablevialink) |  | boolean | **_(ALPHA)_** _(Optional)_ Specify if also dashboards available only via link should be loaded. Such dashboards may not be supported by every backend. Defaults to false. |
| [loadUserData?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetdashboardoptions/index.md#igetdashboardoptionsloaduserdata) |  | boolean | **_(ALPHA)_** _(Optional)_ Specify if information about the users that created/modified the dashboard should be loaded. Defaults to false. If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined. |

## Property details

### IGetDashboardOptions.exportId

> **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).
> 

Specify id of the currently performed dashboard pdf export. This id is used to retrieve export-related metadata, such as currently active attribute filters.

The id is missing when the dashboard is not loaded in the export mode

**Signature:**

```typescript
exportId?: string;
```

### IGetDashboardOptions.exportTabId

> **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).
> 

Tab identifier to export. Used for export of dashboard with tabs.

**Signature:**

```typescript
exportTabId?: string;
```

### IGetDashboardOptions.exportType

> **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).
> 

Specify type of the currently performed dashboard export. This id is used to retrieve export-related metadata, such as currently active attribute filters.

**Signature:**

```typescript
exportType?: "visual" | "slides";
```

### IGetDashboardOptions.includeAvailableViaLink

> **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).
> 

Specify if also dashboards available only via link should be loaded. Such dashboards may not be supported by every backend.

Defaults to false.

**Signature:**

```typescript
includeAvailableViaLink?: boolean;
```

### IGetDashboardOptions.loadUserData

> **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).
> 

Specify if information about the users that created/modified the dashboard should be loaded. Defaults to false.

If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined.

**Signature:**

```typescript
loadUserData?: boolean;
```