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

# IDashboardSummaryRequest

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

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Request payload for AI dashboard summarization.

**Signature:**

```typescript
export interface IDashboardSummaryRequest 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [dashboardId](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardsummaryrequest/index.md#idashboardsummaryrequestdashboardid) |  | string | **_(BETA)_** |
| [filterContext?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardsummaryrequest/index.md#idashboardsummaryrequestfiltercontext) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] \| null | **_(BETA)_** _(Optional)_ Filter context to apply when generating the summary. `null` means use all dashboard filters. Omit to let the backend decide. |
| [formatHint?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardsummaryrequest/index.md#idashboardsummaryrequestformathint) |  | string \| null | **_(BETA)_** _(Optional)_ Hint describing the desired output format of the generated summary. Use it as an additional prompt. |
| [tabId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardsummaryrequest/index.md#idashboardsummaryrequesttabid) |  | string \| null | **_(BETA)_** _(Optional)_ Identifier of the dashboard tab to summarize. Omit to summarize the whole dashboard. |
| [visualizations?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardsummaryrequest/index.md#idashboardsummaryrequestvisualizations) |  | string[] \| null | **_(BETA)_** _(Optional)_ Visualizations to include in the summary. `null` means include all visualizations on the dashboard. Omit to let the backend decide. |

## Property details

### IDashboardSummaryRequest.dashboardId

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
dashboardId: string;
```

### IDashboardSummaryRequest.filterContext

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Filter context to apply when generating the summary. `null` means use all dashboard filters. Omit to let the backend decide.

**Signature:**

```typescript
filterContext?: FilterContextItem[] | null;
```

### IDashboardSummaryRequest.formatHint

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Hint describing the desired output format of the generated summary. Use it as an additional prompt.

**Signature:**

```typescript
formatHint?: string | null;
```

### IDashboardSummaryRequest.tabId

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Identifier of the dashboard tab to summarize. Omit to summarize the whole dashboard.

**Signature:**

```typescript
tabId?: string | null;
```

### IDashboardSummaryRequest.visualizations

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Visualizations to include in the summary. `null` means include all visualizations on the dashboard. Omit to let the backend decide.

**Signature:**

```typescript
visualizations?: string[] | null;
```