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

# IQueryWidgetFilters

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/queries/widgets.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).
> 

Given a reference to a widget, this query will obtain the filters that should be used when executing it. These will respect the ignored filters on widget level as well as the filters specified in the insight itself. Filters returned by this query should be used with [insightSetFilters()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.insightsetfilters/index.md) to obtain insight that is ready for execution or used to execute a KPI.

**Signature:**

```typescript
export interface IQueryWidgetFilters extends IDashboardQuery 
```
**Extends:** [IDashboardQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardquery/index.md)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [payload](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iquerywidgetfilters/index.md#iquerywidgetfilterspayload) | `readonly` | { readonly widgetRef: [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md); readonly insight?: [IInsightDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsightdefinition/index.md) \| null; } | **_(ALPHA)_** |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iquerywidgetfilters/index.md#iquerywidgetfilterstype) | `readonly` | "GDC.DASH/QUERY.WIDGET.FILTERS" | **_(ALPHA)_** |

## Property details

### IQueryWidgetFilters.payload

> **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 payload: {
        readonly widgetRef: ObjRef;
        readonly insight?: IInsightDefinition | null;
    };
```

### IQueryWidgetFilters.type

> **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 type: "GDC.DASH/QUERY.WIDGET.FILTERS";
```