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

# IDashboardCommandFailedPayload

- 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/events/general.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 [IDashboardCommandFailed](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommandfailed/index.md) event.

**Signature:**

```typescript
export interface IDashboardCommandFailedPayload<TCommand extends IDashboardCommand> 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [command](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommandfailedpayload/index.md#idashboardcommandfailedpayloadcommand) | `readonly` | TCommand | **_(BETA)_** The command that failed. |
| [error?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommandfailedpayload/index.md#idashboardcommandfailedpayloaderror) | `readonly` | Error | **_(BETA)_** _(Optional)_ Error that has occurred and caused the command to fail. |
| [message](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommandfailedpayload/index.md#idashboardcommandfailedpayloadmessage) | `readonly` | string | **_(BETA)_** Message explaining the nature of the failure. |
| [reason](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommandfailedpayload/index.md#idashboardcommandfailedpayloadreason) | `readonly` | [ActionFailedErrorReason](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.actionfailederrorreason/index.md) | **_(BETA)_** Reason for the failure. |

## Property details

### IDashboardCommandFailedPayload.command

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

The command that failed.

**Signature:**

```typescript
readonly command: TCommand;
```

### IDashboardCommandFailedPayload.error

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

Error that has occurred and caused the command to fail.

**Signature:**

```typescript
readonly error?: Error;
```

### IDashboardCommandFailedPayload.message

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

Message explaining the nature of the failure.

**Signature:**

```typescript
readonly message: string;
```

### IDashboardCommandFailedPayload.reason

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

Reason for the failure.

**Signature:**

```typescript
readonly reason: ActionFailedErrorReason;
```
