---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://appmetrica.yandex.com/docs/en/mobile-api/stat/ref/data.md
  - https://appmetrica.yandex.com/docs/ru/mobile-api/stat/ref/data.md
---
> **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.com/docs/en/llms.txt

<div class="openapi">

# Table

<!-- markdownlint-disable-file -->

Provides access to statistical data, including data available in reports. Returns results in the form of a table.

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://api.appmetrica.yandex.net/stat/v1/data
```

</div>

</div>

</div>

### Query parameters

#|
|| **Name** | **Description** ||
||

_params_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [ConstructorParams](#entity-ConstructorParams)

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_statGroupParams_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [StatGroupParams](#entity-StatGroupParams)

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### ConstructorParams {#entity-ConstructorParams}

#|
|| **Name** | **Description** ||
||

_access_filter_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

_accuracy_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_callback_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_confidence_level_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `0.95`
{.table-cell}
||
||

_date_dimension_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_date1_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `6daysAgo`
{.table-cell}
||
||

_date2_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `today`
{.table-cell}
||
||

_dimensions_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_direct_client_ids_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0
]
```

{% endcut %}
{.table-cell}
||
||

_direct_client_logins_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_exclude_insignificant_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_filters_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_ids_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0
]
```

{% endcut %}
{.table-cell}
||
||

_include_meta_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_include_undefined_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_lang_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_limit_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `100`
{.table-cell}
||
||

_max_deviation_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `0.1`
{.table-cell}
||
||

_metrics_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_offset_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `1`
{.table-cell}
||
||

_preset_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_pretty_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
||

_proposed_accuracy_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_reference_row_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_request_domain_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_require_metric_values_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
||

_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_timezone_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_with_confidence_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "ids": [
    0
  ],
  "direct_client_ids": [
    0
  ],
  "direct_client_logins": [
    "example"
  ],
  "date1": "6daysAgo",
  "date2": "today",
  "timezone": "example",
  "preset": "example",
  "metrics": "example",
  "dimensions": "example",
  "reference_row_id": [
    "example"
  ],
  "filters": "example",
  "accuracy": "example",
  "proposed_accuracy": true,
  "include_undefined": true,
  "include_meta": true,
  "with_confidence": true,
  "exclude_insignificant": true,
  "confidence_level": "0.95",
  "max_deviation": "0.1",
  "pretty": "false",
  "lang": "example",
  "request_domain": "example",
  "require_metric_values": "false",
  "access_filter_id": 0,
  "callback": "example",
  "date_dimension": "example",
  "sort": "example",
  "limit": "100",
  "offset": "1"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### StatGroupParams {#entity-StatGroupParams}

#|
|| **Name** | **Description** ||
||

_label_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

_Min value:_{.json-schema-reset .json-schema-assertion} `1`
{.table-cell}
||
||

_org_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

_Min value:_{.json-schema-reset .json-schema-assertion} `1`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "org_id": 1,
  "label_id": 1
}
```

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "query": {
    "timezone": "example",
    "preset": "example",
    "dimensions": [
      "example"
    ],
    "metrics": [
      "example"
    ],
    "sort": [
      "example"
    ],
    "date1": "example",
    "date2": "example",
    "filters": "example",
    "limit": 0,
    "offset": 0
  },
  "data": [
    {
      "dimensions": [
        {}
      ],
      "metrics": [
        0.5
      ]
    }
  ],
  "total_rows": 0,
  "total_rows_rounded": true,
  "sampled": true,
  "contains_sensitive_data": true,
  "sample_share": 0.5,
  "sample_size": 0,
  "sample_space": 0,
  "data_lag": 0,
  "totals": [
    0.5
  ],
  "min": [
    0.5
  ],
  "max": [
    0.5
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_contains_sensitive_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Indicates whether [sensitive data](https://yandex.com/support/metrica/reports/report-general.html#privacy) can be omitted from the response. Such data includes data calculated by Yandex algorithms: demographic data (gender, age, and other), login page addresses, search phrases, and robot information. If the value is `true`, the response will not display such data if the sample is less than 10 users.
Possible values: `true`, `false`.
{.table-cell}
||
||

_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [StaticRow](#entity-StaticRow)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "dimensions": [
      {}
    ],
    "metrics": [
      0.5
    ]
  }
]
```

{% endcut %}
{.table-cell}
||
||

_data_lag_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Delay in updating data, in seconds.
{.table-cell}
||
||

_max_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0.5
]
```

{% endcut %}
{.table-cell}
||
||

_min_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0.5
]
```

{% endcut %}
{.table-cell}
||
||

_query_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [QueryExternal](#entity-QueryExternal)

Original request. Contains the request parameters, including detailed parameters from the template and parameters for attribute parametrization.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "timezone": "example",
  "preset": "example",
  "dimensions": [
    "example"
  ],
  "metrics": [
    "example"
  ],
  "sort": [
    "example"
  ],
  "date1": "example",
  "date2": "example",
  "filters": "example",
  "limit": 0,
  "offset": 0
}
```

{% endcut %}
{.table-cell}
||
||

_sample_share_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

Percentage of data used for the calculation. Available values range from 0 to 1.
{.table-cell}
||
||

_sample_size_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Number of rows in the requested data.
{.table-cell}
||
||

_sample_space_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Number of data rows.
{.table-cell}
||
||

_sampled_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Sampling flag. Indicates whether sampling was applied. Possible values: `true`, `false`.
{.table-cell}
||
||

_total_rows_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

The total number of rows in the response for the entire dataset (after filtering).
{.table-cell}
||
||

_total_rows_rounded_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Indicates that the total number of rows was rounded.
{.table-cell}
||
||

_totals_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0.5
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### QueryExternal {#entity-QueryExternal}

Original request. Contains the request parameters, including detailed parameters from the template and parameters for attribute parametrization.

#|
|| **Name** | **Description** ||
||

_date1_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Start date of the report period in the format YYYY-MM-DD.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_date2_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

End date of the report period in the format YYYY-MM-DD.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dimensions_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_filters_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Segmentation filter.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_limit_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Number of items on the results page.
{.table-cell}
||
||

_metrics_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_offset_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Index of the first row of requested data, starting from 1.
{.table-cell}
||
||

_preset_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Report preset.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_timezone_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

The time zone of the selection period in the format ±hh:mm.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "timezone": "example",
  "preset": "example",
  "dimensions": [
    "example"
  ],
  "metrics": [
    "example"
  ],
  "sort": [
    "example"
  ],
  "date1": "example",
  "date2": "example",
  "filters": "example",
  "limit": 0,
  "offset": 0
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### StaticRow {#entity-StaticRow}

Response rows. An array in which each item is a single row of the result.

#|
|| **Name** | **Description** ||
||

_dimensions_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}

#|
||

_[additional]_{.json-schema-reset .json-schema-additional-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% endcut %}

Array of dimension values for this row. Each dimension value is an object. It must have the `name` field, which is a text value. But it can also have additional fields, such as `id`.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {}
]
```

{% endcut %}
{.table-cell}
||
||

_metrics_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0.5
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "dimensions": [
    {}
  ],
  "metrics": [
    0.5
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ParamMetaExternal {#entity-ParamMetaExternal}

List of metric parameters

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Parameter description

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dim_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Name of a dimension with values

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Parameter ID

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "description": "example",
  "dim": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DimensionMetaExternal {#entity-DimensionMetaExternal}

#|
|| **Name** | **Description** ||
||

_advanced_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Dimension for an advanced user
{.table-cell}
||
||

_allow_filters_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether filters can be used
{.table-cell}
||
||

_allow_null_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether "Undefined" can be shown for this dimension
{.table-cell}
||
||

_allow_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether sorting by this dimension is allowed
{.table-cell}
||
||

_chained_attributes_group_index_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Dimension order in a group of linked dimensions
{.table-cell}
||
||

_chained_attributes_group_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Name of a group of linked dimensions

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_default_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Sorting method:
- `asc`
- `desc`


_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Metric description

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dim_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Grouping data

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_disallow_by_time_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether this dimension is allowed along with grouping data by time.
{.table-cell}
||
||

_features_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

Tag characteristics required for dimension use

_Unique items:_{.json-schema-reset .json-schema-assertion} `true`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_fields_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
||

_[additional]_{.json-schema-reset .json-schema-additional-property}
{.table-cell}|
**Type**: [DimensionMetaExternal](#entity-DimensionMetaExternal)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "dim": "example",
  "name": "example",
  "short_name": "example",
  "group_name": "example",
  "description": "example",
  "type": "example",
  "disallow_by_time": true,
  "allow_filters": true,
  "parameter": {
    "id": "example",
    "description": "example",
    "dim": "example"
  },
  "fields": {},
  "allow_sort": true,
  "default_sort": "example",
  "allow_null": true,
  "sub_table": "example",
  "permission_scope": "example",
  "since": "example",
  "advanced": true,
  "required_keys": [
    "example"
  ],
  "features": [
    "example"
  ],
  "chained_attributes_group_name": "example",
  "chained_attributes_group_index": 0
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% endcut %}

Additional fields for the current dimension

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
||

_group_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Names of dimensions when enumerating them

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Dimension ID without any prefix or parameters

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Dimension name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_parameter_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ParamMetaExternal](#entity-ParamMetaExternal)

List of metric parameters

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "description": "example",
  "dim": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_permission_scope_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Dimension access group

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_required_keys_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_short_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Dimension name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_since_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Date when dimension data appeared

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_sub_table_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Subtable

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Dimension interface type

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "dim": "example",
  "name": "example",
  "short_name": "example",
  "group_name": "example",
  "description": "example",
  "type": "example",
  "disallow_by_time": true,
  "allow_filters": true,
  "parameter": {
    "id": "example",
    "description": "example",
    "dim": "example"
  },
  "fields": {},
  "allow_sort": true,
  "default_sort": "example",
  "allow_null": true,
  "sub_table": "example",
  "permission_scope": "example",
  "since": "example",
  "advanced": true,
  "required_keys": [
    "example"
  ],
  "features": [
    "example"
  ],
  "chained_attributes_group_name": "example",
  "chained_attributes_group_index": 0
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### MetricMetaExternal {#entity-MetricMetaExternal}

Array of request metric metadata.

#|
|| **Name** | **Description** ||
||

_advanced_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Metric for advanced users
{.table-cell}
||
||

_allow_filters_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether filters can be used
{.table-cell}
||
||

_allow_normalisation_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether values can be normalized
{.table-cell}
||
||

_allow_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether data can be sorted by this metric
{.table-cell}
||
||

_default_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Sorting method:
- `asc`
- `desc`


_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Metric description

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dim_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Metric

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_exposes_secret_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Discloses sensitive data
{.table-cell}
||
||

_features_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

Tag characteristics required for metric use

_Unique items:_{.json-schema-reset .json-schema-assertion} `true`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_metric_string_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Metric with a parameter value

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Metric name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_negative_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether the metric is a negative indicator in terms of data interpretation, for example, the bounce rate, robot percentage, and so on.
{.table-cell}
||
||

_parameters_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ParamMetaExternal](#entity-ParamMetaExternal)[]

List of metric parameters

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "description": "example",
    "dim": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_permission_scope_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Metric access group

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_require_dynamic_correction_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether values require adjustments in the time report
{.table-cell}
||
||

_required_dimension_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Dimension required for the metric

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_required_keys_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_secret_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Contains sensitive data
{.table-cell}
||
||

_since_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Date when metric data appeared

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_sub_table_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Subtable

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_support_confidence_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Whether confidence can be estimated by this metric
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Metric type.
- `int`
- `double`
- `second`
- `millisecond`
- `affinity`
- `percents`
- `currency`


_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "dim": "example",
  "metric_string": "example",
  "name": "example",
  "description": "example",
  "allow_normalisation": true,
  "require_dynamic_correction": true,
  "allow_filters": true,
  "type": "example",
  "allow_sort": true,
  "default_sort": "example",
  "advanced": true,
  "support_confidence": true,
  "negative": true,
  "parameters": [
    {
      "id": "example",
      "description": "example",
      "dim": "example"
    }
  ],
  "sub_table": "example",
  "required_dimension": "example",
  "permission_scope": "example",
  "since": "example",
  "required_keys": [
    "example"
  ],
  "features": [
    "example"
  ],
  "secret": true,
  "exposes_secret_data": true
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.