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

# v1.CalculatedMetricField

- 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 CalculatedMetricField 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [aggregation](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.calculatedmetricfield/index.md#v1calculatedmetricfieldaggregation) |  | "SUM" \| "COUNT" \| "APPROXIMATE\_COUNT" \| "AVG" \| "MIN" \| "MAX" \| "MEDIAN" \| "RUNSUM" | Aggregation function to use for this field. |
| [compute\_ratio?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.calculatedmetricfield/index.md#v1calculatedmetricfieldcompute_ratio) |  | boolean | _(Optional)_ Compute ratio for this metric. |
| [filter\_by?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.calculatedmetricfield/index.md#v1calculatedmetricfieldfilter_by) |  | [QueryFilters1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.queryfilters1/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.calculatedmetricfield/index.md#v1calculatedmetricfieldtitle) |  | string | _(Optional)_ A field title. |
| [using](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.calculatedmetricfield/index.md#v1calculatedmetricfieldusing) |  | ([AttributeIdentifier12](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attributeidentifier12/index.md) \| [FactIdentifier1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.factidentifier1/index.md) \| [LabelIdentifier13](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.labelidentifier13/index.md)) & string | Attribute identifier to use for this field. |

## Property details

### v1.CalculatedMetricField.aggregation

Aggregation function to use for this field.

**Signature:**

```typescript
aggregation: "SUM" | "COUNT" | "APPROXIMATE_COUNT" | "AVG" | "MIN" | "MAX" | "MEDIAN" | "RUNSUM";
```

### v1.CalculatedMetricField.compute_ratio

Compute ratio for this metric.

**Signature:**

```typescript
compute_ratio?: boolean;
```

### v1.CalculatedMetricField.filter_by

**Signature:**

```typescript
filter_by?: QueryFilters1;
```

### v1.CalculatedMetricField.title

A field title.

**Signature:**

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

### v1.CalculatedMetricField.using

Attribute identifier to use for this field.

**Signature:**

```typescript
using: (AttributeIdentifier12 | FactIdentifier1 | LabelIdentifier13) & string;
```