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

# v1.PreviousPeriodMetricField

- Package: [@gooddata/sdk-code-schemas](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-code-schemas/src/v1/metadata.ts

**Signature:**

```typescript
export interface PreviousPeriodMetricField 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [date\_filter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.previousperiodmetricfield/index.md#v1previousperiodmetricfielddate_filter) |  | string | Date filter to use for this field. |
| [period?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.previousperiodmetricfield/index.md#v1previousperiodmetricfieldperiod) |  | number | _(Optional)_ Number of periods ago to use for this field. |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.previousperiodmetricfield/index.md#v1previousperiodmetricfieldtitle) |  | string | _(Optional)_ A field title. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.previousperiodmetricfield/index.md#v1previousperiodmetricfieldtype) |  | "PREVIOUS\_PERIOD" | Type of relative period metric related to another metric in list. |
| [using](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.previousperiodmetricfield/index.md#v1previousperiodmetricfieldusing) |  | string | Identifier to use for this field. |

## Property details

### v1.PreviousPeriodMetricField.date_filter

Date filter to use for this field.

**Signature:**

```typescript
date_filter: string;
```

### v1.PreviousPeriodMetricField.period

Number of periods ago to use for this field.

**Signature:**

```typescript
period?: number;
```

### v1.PreviousPeriodMetricField.title

A field title.

**Signature:**

```typescript
title?: string;
```

### v1.PreviousPeriodMetricField.type

Type of relative period metric related to another metric in list.

**Signature:**

```typescript
type: "PREVIOUS_PERIOD";
```

### v1.PreviousPeriodMetricField.using

Identifier to use for this field.

**Signature:**

```typescript
using: string;
```