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

# IModifyDrillsForInsightWidgetPayload

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

Payload of the [IModifyDrillsForInsightWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imodifydrillsforinsightwidget/index.md) command.

**Signature:**

```typescript
export interface IModifyDrillsForInsightWidgetPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [blacklistHierarchiesToUpdate?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imodifydrillsforinsightwidgetpayload/index.md#imodifydrillsforinsightwidgetpayloadblacklisthierarchiestoupdate) | `readonly` | [IDrillDownReference](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idrilldownreference/index.md)[] | **_(BETA)_** _(Optional)_ Specify which drill down localIdentifier and its hierarchy should be removed. |
| [drills](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imodifydrillsforinsightwidgetpayload/index.md#imodifydrillsforinsightwidgetpayloaddrills) | `readonly` | [InsightDrillDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.insightdrilldefinition/index.md)[] | **_(BETA)_** New drill definitions. The drills are defined per measure in insight and there can be exactly one drill definition for insight measure. The newly provided items will be matches to existing items by the measure they are linked to. The definition of drill for that measure will be modified. Note: this can do upsert. if you specify drill for a measure and there is no existing drill for it, then the new definition will be used. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imodifydrillsforinsightwidgetpayload/index.md#imodifydrillsforinsightwidgetpayloadref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** Reference to Insight Widget whose drill items should be modified. |

## Property details

### IModifyDrillsForInsightWidgetPayload.blacklistHierarchiesToUpdate

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

Specify which drill down localIdentifier and its hierarchy should be removed.

**Signature:**

```typescript
readonly blacklistHierarchiesToUpdate?: IDrillDownReference[];
```

### IModifyDrillsForInsightWidgetPayload.drills

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

New drill definitions. The drills are defined per measure in insight and there can be exactly one drill definition for insight measure.

The newly provided items will be matches to existing items by the measure they are linked to. The definition of drill for that measure will be modified.

Note: this can do upsert. if you specify drill for a measure and there is no existing drill for it, then the new definition will be used.

**Signature:**

```typescript
readonly drills: InsightDrillDefinition[];
```

### IModifyDrillsForInsightWidgetPayload.ref

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

Reference to Insight Widget whose drill items should be modified.

**Signature:**

```typescript
readonly ref: ObjRef;
```