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

# IAutomationMetadataObjectBase

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

**Signature:**

```typescript
export interface IAutomationMetadataObjectBase 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [alert?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbasealert) |  | [IAutomationAlert](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationalert/index.md) | **_(ALPHA)_** _(Optional)_ Alerting configuration of the automation. |
| [dashboard?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbasedashboard) |  | { id?: [Identifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifier/index.md); title?: string; } | **_(ALPHA)_** _(Optional)_ Dashboard that automation is related to. |
| [details?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbasedetails) |  | [IAutomationDetails](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationdetails/index.md) | **_(ALPHA)_** _(Optional)_ Details of the automation. |
| [evaluationMode?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbaseevaluationmode) |  | [AutomationEvaluationMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.automationevaluationmode/index.md) | **_(ALPHA)_** _(Optional)_ Evaluation mode for the automation. |
| [exportDefinitions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbaseexportdefinitions) |  | [IExportDefinitionMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexportdefinitionmetadataobject/index.md)[] | **_(ALPHA)_** _(Optional)_ Export definitions of the automation (attachments). |
| [lastRun?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbaselastrun) |  | { status?: [IAutomationLastRunStatus](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationlastrunstatus/index.md); executedAt?: string; traceId?: string; errorMessage?: string; } | **_(ALPHA)_** _(Optional)_ Last run of the automation. |
| [metadata?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbasemetadata) |  | { widget?: string; targetTabIdentifier?: string; filters?: string[]; visibleFilters?: [IAutomationVisibleFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationvisiblefilter/index.md)[]; visibleFiltersByTab?: Record&lt;string, [IAutomationVisibleFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationvisiblefilter/index.md)[]&gt;; originalSchedule?: [IAutomationSchedule](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationschedule/index.md); } | **_(ALPHA)_** _(Optional)_ Additional metadata of the automation. |
| [notificationChannel?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbasenotificationchannel) |  | string | **_(ALPHA)_** _(Optional)_ Target notificationChannel that automation will trigger. String with webhook (notificationChannel) id. |
| [notificationChannelTitle?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbasenotificationchanneltitle) |  | string | **_(ALPHA)_** _(Optional)_ Title of the notification channel. |
| [recipients?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbaserecipients) |  | [IAutomationRecipient](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationrecipient/index.md)[] | **_(ALPHA)_** _(Optional)_ Recipients of the automation. |
| [schedule?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbaseschedule) |  | [IAutomationSchedule](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationschedule/index.md) | **_(ALPHA)_** _(Optional)_ Schedule of the automation. Object with cron expression, timezone and first run timestamp. |
| [state?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbasestate) |  | [IAutomationState](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationstate/index.md) | **_(ALPHA)_** _(Optional)_ State of the automation. |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectbase/index.md#iautomationmetadataobjectbaseworkspace) |  | { id?: [Identifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifier/index.md); title?: string; } | **_(ALPHA)_** _(Optional)_ Workspace that automation is related to. |

## Property details

### IAutomationMetadataObjectBase.alert

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

Alerting configuration of the automation.

**Signature:**

```typescript
alert?: IAutomationAlert;
```

### IAutomationMetadataObjectBase.dashboard

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

Dashboard that automation is related to.

**Signature:**

```typescript
dashboard?: {
        id?: Identifier;
        title?: string;
    };
```

### IAutomationMetadataObjectBase.details

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

Details of the automation.

**Signature:**

```typescript
details?: IAutomationDetails;
```

### IAutomationMetadataObjectBase.evaluationMode

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

Evaluation mode for the automation.

**Signature:**

```typescript
evaluationMode?: AutomationEvaluationMode;
```

### IAutomationMetadataObjectBase.exportDefinitions

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

Export definitions of the automation (attachments).

**Signature:**

```typescript
exportDefinitions?: IExportDefinitionMetadataObject[];
```

### IAutomationMetadataObjectBase.lastRun

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

Last run of the automation.

**Signature:**

```typescript
lastRun?: {
        status?: IAutomationLastRunStatus;
        executedAt?: string;
        traceId?: string;
        errorMessage?: string;
    };
```

### IAutomationMetadataObjectBase.metadata

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

Additional metadata of the automation.

**Signature:**

```typescript
metadata?: {
        widget?: string;
        targetTabIdentifier?: string;
        filters?: string[];
        visibleFilters?: IAutomationVisibleFilter[];
        visibleFiltersByTab?: Record<string, IAutomationVisibleFilter[]>;
        originalSchedule?: IAutomationSchedule;
    };
```

### IAutomationMetadataObjectBase.notificationChannel

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

Target notificationChannel that automation will trigger. String with webhook (notificationChannel) id.

**Signature:**

```typescript
notificationChannel?: string;
```

### IAutomationMetadataObjectBase.notificationChannelTitle

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

Title of the notification channel.

**Signature:**

```typescript
notificationChannelTitle?: string;
```

### IAutomationMetadataObjectBase.recipients

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

Recipients of the automation.

**Signature:**

```typescript
recipients?: IAutomationRecipient[];
```

### IAutomationMetadataObjectBase.schedule

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

Schedule of the automation. Object with cron expression, timezone and first run timestamp.

**Signature:**

```typescript
schedule?: IAutomationSchedule;
```

### IAutomationMetadataObjectBase.state

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

State of the automation.

**Signature:**

```typescript
state?: IAutomationState;
```

### IAutomationMetadataObjectBase.workspace

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

Workspace that automation is related to.

**Signature:**

```typescript
workspace?: {
        id?: Identifier;
        title?: string;
    };
```
