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

# IDashboardReferences

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

Dashboard referenced objects

**Signature:**

```typescript
export interface IDashboardReferences 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [dataSets?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardreferences/index.md#idashboardreferencesdatasets) |  | [IDataSetMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasetmetadataobject/index.md)[] | **_(ALPHA)_** _(Optional)_ Referenced dataSets. Only direct references, does not include dataSets linked from filter context. |
| [insights](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardreferences/index.md#idashboardreferencesinsights) |  | [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)[] | **_(ALPHA)_** Referenced insights. Empty if no insights on dashboard or referenced insights were not requested. |
| [plugins](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardreferences/index.md#idashboardreferencesplugins) |  | [IDashboardPlugin](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardplugin/index.md)[] | **_(ALPHA)_** Referenced plugins. Empty if no plugins on dashboard or referenced plugins were not requested. |
| [unavailable?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardreferences/index.md#idashboardreferencesunavailable) |  | [IUnavailableDashboardReference](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iunavailabledashboardreference/index.md)[] | **_(ALPHA)_** _(Optional)_ Referenced objects that were requested but could not be returned, each with the reason (see [IUnavailableDashboardReference](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iunavailabledashboardreference/index.md)): the current user is not allowed to read the object, or the object no longer exists. How to use it: for a reference that IS listed, you know why it is missing and can show something better than a generic error (for example a "no access" placeholder). For a reference that is NOT listed, keep doing what you did before this field existed — load the object and handle a failure the usual way. The list is not guaranteed to be complete: when the backend fails while checking one kind of reference, it logs the failure and leaves those references out of the list rather than failing the whole dashboard load. Undefined means the backend does not perform this check at all; treat it like an empty list. |

## Property details

### IDashboardReferences.dataSets

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

Referenced dataSets. Only direct references, does not include dataSets linked from filter context.

**Signature:**

```typescript
dataSets?: IDataSetMetadataObject[];
```

### IDashboardReferences.insights

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

Referenced insights. Empty if no insights on dashboard or referenced insights were not requested.

**Signature:**

```typescript
insights: IInsight[];
```

### IDashboardReferences.plugins

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

Referenced plugins. Empty if no plugins on dashboard or referenced plugins were not requested.

**Signature:**

```typescript
plugins: IDashboardPlugin[];
```

### IDashboardReferences.unavailable

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

Referenced objects that were requested but could not be returned, each with the reason (see [IUnavailableDashboardReference](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iunavailabledashboardreference/index.md)): the current user is not allowed to read the object, or the object no longer exists.

How to use it: for a reference that IS listed, you know why it is missing and can show something better than a generic error (for example a "no access" placeholder). For a reference that is NOT listed, keep doing what you did before this field existed — load the object and handle a failure the usual way. The list is not guaranteed to be complete: when the backend fails while checking one kind of reference, it logs the failure and leaves those references out of the list rather than failing the whole dashboard load.

Undefined means the backend does not perform this check at all; treat it like an empty list.

**Signature:**

```typescript
unavailable?: IUnavailableDashboardReference[];
```
