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

# IChangeKpiWidgetConfigurationPayload

- 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/kpi.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 [IChangeKpiWidgetConfiguration](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangekpiwidgetconfiguration/index.md) command.

**Signature:**

```typescript
export interface IChangeKpiWidgetConfigurationPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [config](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangekpiwidgetconfigurationpayload/index.md#ichangekpiwidgetconfigurationpayloadconfig) | `readonly` | [IKpiWidgetConfiguration](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ikpiwidgetconfiguration/index.md) \| undefined | **_(BETA)_** Configuration to use for the kpi that is rendered by the widget. These will replace the existing configuration. To clear any widget-level configuration currently in effect for the widget, set the configuration to `undefined`. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangekpiwidgetconfigurationpayload/index.md#ichangekpiwidgetconfigurationpayloadref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** Reference to Kpi Widget whose configuration to change. |

## Property details

### IChangeKpiWidgetConfigurationPayload.config

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

Configuration to use for the kpi that is rendered by the widget.

These will replace the existing configuration. To clear any widget-level configuration currently in effect for the widget, set the configuration to `undefined`.

**Signature:**

```typescript
readonly config: IKpiWidgetConfiguration | undefined;
```

### IChangeKpiWidgetConfigurationPayload.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 Kpi Widget whose configuration to change.

**Signature:**

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