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

# v1.Metric

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metricdescription) |  | string | _(Optional)_ An optional description of the metric. |
| [format?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metricformat) |  | string | _(Optional)_ Metric value default format |
| [id](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metricid) |  | [Id7](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id7/index.md) |  |
| [is\_hidden?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metricis_hidden) |  | boolean | _(Optional)_ |
| [maql](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metricmaql) |  | string | Define MAQL syntax for metric. |
| [show\_in\_ai\_results?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metricshow_in_ai_results) |  | boolean | _(Optional)_ Optional flag to indicate if the metric should be shown in AI results. When omitted, the metric is visible. |
| [tags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metrictags) |  | [Tags8](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags8/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metrictitle) |  | string | _(Optional)_ An optional human readable title for the metric. Will be derived from id if not provided explicitly. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.metric/index.md#v1metrictype) |  | "metric" |  |

## Property details

### v1.Metric.description

An optional description of the metric.

**Signature:**

```typescript
description?: string;
```

### v1.Metric.format

Metric value default format

**Signature:**

```typescript
format?: string;
```

### v1.Metric.id

**Signature:**

```typescript
id: Id7;
```

### v1.Metric.is_hidden

> Warning: This API is now obsolete.
> 
> Deprecated. Use 'show\_in\_ai\_results' instead.
> 

**Signature:**

```typescript
is_hidden?: boolean;
```

### v1.Metric.maql

Define MAQL syntax for metric.

**Signature:**

```typescript
maql: string;
```

### v1.Metric.show_in_ai_results

Optional flag to indicate if the metric should be shown in AI results. When omitted, the metric is visible.

**Signature:**

```typescript
show_in_ai_results?: boolean;
```

### v1.Metric.tags

**Signature:**

```typescript
tags?: Tags8;
```

### v1.Metric.title

An optional human readable title for the metric. Will be derived from id if not provided explicitly.

**Signature:**

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

### v1.Metric.type

**Signature:**

```typescript
type: "metric";
```