---
metadata:
  - name: generator
    content: Diplodoc Platform v5.48.2
alternate:
  - https://yandex.com.tr/dev/metrika/en/management/openapi/counter/addCounter.md
  - https://yandex.com.tr/dev/metrika/ru/management/openapi/counter/addCounter.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/metrika/en/llms.txt

<!-- source: en/management-src/Managing-counters/addCounter.md -->
<div class="openapi">

# Creating a tag

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

Creates a tag with set parameters. A single user can create no more than 100,000 tags.

## Request

<div class="openapi__requests">

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

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
https://api-metrika.yandex.net/management/v1/counters
```

</div>

</div>

</div>

### Query parameters

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

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

One or several additional parameters of a returned object. The names of the additional parameters are specified in any order, separated by commas, without spaces. Example: `field=goals,mirrors,grants,filters,operations,counter_flags,measurement_tokens`.

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

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

Whether the tag management system is used.

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "counter": {
    "id": 0,
    "status": "example",
    "owner_login": "example",
    "activity_status": "example",
    "name": "example",
    "type": "example",
    "favorite": true,
    "permission": "example",
    "goals": [
      null
    ],
    "filters": [
      {
        "id": 0,
        "attr": "example",
        "type": "example",
        "value": "example",
        "action": "example",
        "status": "example",
        "start_ip": "example",
        "end_ip": "example",
        "with_subdomains": true
      }
    ],
    "operations": [
      {
        "id": 0,
        "action": "example",
        "attr": "example",
        "value": "example",
        "status": "example"
      }
    ],
    "grants": [
      {
        "user_login": "example",
        "perm": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "comment": "example",
        "partner_data_access": true
      }
    ],
    "labels": [
      {
        "id": 0,
        "name": "example"
      }
    ],
    "webvisor": {
      "urls": "example",
      "arch_enabled": true,
      "arch_type": "example",
      "load_player_type": "example",
      "wv_version": 0,
      "wv_forms": true
    },
    "code_options": {
      "async": true,
      "informer": {
        "enabled": true,
        "type": "example",
        "size": 1,
        "indicator": "example",
        "color_start": "FFFFFFFF.",
        "color_end": "EFEFEFFF",
        "color_text": 0,
        "color_arrow": 0
      },
      "visor": true,
      "track_hash": true,
      "xml_site": true,
      "clickmap": true,
      "in_one_line": true,
      "ecommerce": true,
      "alternative_cdn": true
    },
    "create_time": "2025-01-01T00:00:00Z",
    "time_zone_name": "example",
    "time_zone_offset": 0,
    "partner_id": 0,
    "update_time": "example",
    "delete_time": "example",
    "code": "example",
    "filter_robots": 1,
    "visit_threshold": 1800,
    "publisher_options": {
      "enabled": true,
      "schema": "example",
      "schema_options": [
        "example"
      ]
    },
    "vendor_id": 0,
    "site2": {
      "site": "example"
    },
    "gdpr_agreement_accepted": true,
    "mirrors2": [
      null
    ],
    "autogoals_enabled": true,
    "counter_flags": {
      "use_in_benchmarks": true,
      "direct_allow_use_goals_without_access": true,
      "collect_first_party_data": true,
      "measurement_enabled": true
    },
    "measurement_tokens": [
      "example"
    ]
  }
}
```

{% endcut %}

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

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

Tag.

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

```json translate=no
{
  "id": 0,
  "status": "example",
  "owner_login": "example",
  "activity_status": "example",
  "name": "example",
  "type": "example",
  "favorite": true,
  "permission": "example",
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "flag": "example"
    }
  ],
  "filters": [
    {
      "id": 0,
      "attr": "example",
      "type": "example",
      "value": "example",
      "action": "example",
      "status": "example",
      "start_ip": "example",
      "end_ip": "example",
      "with_subdomains": true
    }
  ],
  "operations": [
    {
      "id": 0,
      "action": "example",
      "attr": "example",
      "value": "example",
      "status": "example"
    }
  ],
  "grants": [
    {
      "user_login": "example",
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "partner_data_access": true
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "example"
    }
  ],
  "webvisor": {
    "urls": "example",
    "arch_enabled": true,
    "arch_type": "example",
    "load_player_type": "example",
    "wv_version": 0,
    "wv_forms": true
  },
  "code_options": {
    "async": true,
    "informer": {
      "enabled": true,
      "type": "example",
      "size": 1,
      "indicator": "example",
      "color_start": "FFFFFFFF.",
      "color_end": "EFEFEFFF",
      "color_text": 0,
      "color_arrow": 0
    },
    "visor": true,
    "track_hash": true,
    "xml_site": true,
    "clickmap": true,
    "in_one_line": true,
    "ecommerce": true,
    "alternative_cdn": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 0,
  "partner_id": 0,
  "update_time": "example",
  "delete_time": "example",
  "code": "example",
  "filter_robots": 1,
  "visit_threshold": 1800,
  "publisher_options": {
    "enabled": true,
    "schema": "example",
    "schema_options": [
      "example"
    ]
  },
  "vendor_id": 0,
  "site2": {
    "site": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "autogoals_enabled": true,
  "counter_flags": {
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "collect_first_party_data": true,
    "measurement_enabled": true
  },
  "measurement_tokens": [
    "example"
  ]
}
```

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

</div>

<div class="openapi-entity">

### GoalE {#entity-GoalE}

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

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

Goal name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

Goal type:
- `action`: JavaScript event.
- `chat`: Click on a chat.
- `email`: Click on an email address.
- `file`: File download.
- `messenger`: Click-through to a messenger.
- `number`: Number of views.
- `payment_system`: Payment system.
- `phone`: Click on a phone number.
- `search`: Site search.
- `social`: Click-through to social media.
- `step`: Multi-step goal.
- `url`: Pageviews.
- `visit_duration`: Session duration.


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

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

Default goal cost.
{.table-cell}
||
||

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

ID of the goal. Specify this parameter when changing and deleting a tag goal.
{.table-cell}
||
||

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

Whether the goal is favorite:
- 0: False (default).
- 1: True.

{.table-cell}
||
||

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

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

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### GoalCondition {#entity-GoalCondition}

List of structures with the goal conditions.

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

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

Condition type:
- `contain`: Contains.
- `exact`: Matches exactly.
- `start`: Starts with.
- `regexp`: Matches a regular expression.
- `action`: Special type of conditions for the “JavaScript event” goals.
- `messenger`: Special type of conditions for “form“ goals, path in the DOM tree.
- `all_files`: Attribute for “Open messenger“ goals.
- `file`: Downloading a specific file for “File downloads” goals.
- `search`: Attribute for "Site search" goals.
- `all_social`: Special condition type for `social` goals (all social networks).
- `social`: Special condition type for `social` goals (a specific social network).
- `regexp_action`: JS event matches a regular expression (used exclusively in a step of a multi-step goal).
- `contain_action`: JS event contains (used only in a step of a multi-step goal).


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

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

The value depends on the goal type:
- **Page view**. The URL of the page or a section of the page for the condition.
- **Click on email** or **Click on phone number**. Email or phone number specified in the links on the site. Learn more about tracking clicks on [email addresses](https://yandex.com/support/metrica/simple-goal/email.html) or [phone numbers](https://yandex.com/support/metrica/simple-goal/tel.html).
- **Open a messaging app**. Name of the messaging app retrieved using the [GET management/v1/messengers](https://yandex.com.tr/dev/metrika/en/management/openapi/goal/getMessengers.md) method, or the `all_messengers` value.
- **Site search**. The GET parameter that is used for site search. Yandex Metrica automatically recognizes the `q`, `text`, `query`, and `search` parameters. If the site uses a different parameter, specify it in the request.
- **File download**. File name. For example, `example.pdf`. You can leave this blank if you want to track all file downloads on the site.
- **Click-through to a social network**. The name of the social network, obtained using the [GET management/v1/social_networks](https://yandex.com.tr/dev/metrika/en/management/openapi/goal/getSocialNetworks.md) method, or the `all_social` value.


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

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

```json translate=no
{
  "type": "example",
  "url": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ActionGoal {#entity-ActionGoal}

JavaScript event.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ChatGoalCondition {#entity-ChatGoalCondition}

List of structures with the goal conditions.

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

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

What the goal applies to:
- `chat_answered`: Status of a chat response.
- `chat_platform`: Chat platform.
- `chat_tag`: Chat tag.


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

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

```json translate=no
{
  "field": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ChatGoalConditionAnswered {#entity-ChatGoalConditionAnswered}

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [ChatGoalCondition](#entity-ChatGoalCondition)

  List of structures with the goal conditions.

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

  ```json translate=no
  {
    "field": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  Status of a chat response.
  {.table-cell}
  ||
  |#{.json-schema-properties}

  {% endcut %}

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

  ```json translate=no
  {
    "answered": true
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "field": "example",
  "answered": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ChatGoalConditionPlatform {#entity-ChatGoalConditionPlatform}

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [ChatGoalCondition](#entity-ChatGoalCondition)

  List of structures with the goal conditions.

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

  ```json translate=no
  {
    "field": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  Chat platform.
  Possible values:
  - `telegram`
  - `viber`
  - `whatsApp`


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

  {% endcut %}

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

  ```json translate=no
  {
    "platform": "telegram"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "field": "example",
  "platform": "telegram"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ChatGoalConditionTag {#entity-ChatGoalConditionTag}

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [ChatGoalCondition](#entity-ChatGoalCondition)

  List of structures with the goal conditions.

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

  ```json translate=no
  {
    "field": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  Condition type. Possible values:
  - `contain`: Contains.
  - `exact`: Matches exactly.
  - `start`: Starts with.
  - `regexp`: Matches a regular expression.


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

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

  _Min length:_{.json-schema-reset .json-schema-assertion} `1`

  _Max length:_{.json-schema-reset .json-schema-assertion} `1024`

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

  {% endcut %}

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

  ```json translate=no
  {
    "operator": "example",
    "value": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "field": "example",
  "operator": "example",
  "value": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ChatGoal {#entity-ChatGoal}

Click or tap on a chat.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  {% cut "**One of 3 types**" %}{.json-schema-combinators data-marker=or}

  - **Type**: [ChatGoalConditionAnswered](#entity-ChatGoalConditionAnswered)

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

    ```json translate=no
    {
      "field": "example",
      "answered": true
    }
    ```

    {% endcut %}

  - **Type**: [ChatGoalConditionPlatform](#entity-ChatGoalConditionPlatform)

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

    ```json translate=no
    {
      "field": "example",
      "platform": "telegram"
    }
    ```

    {% endcut %}

  - **Type**: [ChatGoalConditionTag](#entity-ChatGoalConditionTag)

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

    ```json translate=no
    {
      "field": "example",
      "operator": "example",
      "value": "example"
    }
    ```

    {% endcut %}

  {% endcut %}

  {% endcut %}

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

  ```json translate=no
  [
    {
      "field": "example",
      "answered": true
    }
  ]
  ```

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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "field": "example",
        "answered": true
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    null
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ConditionalGoal {#entity-ConditionalGoal}

List of steps in a multi-step goal.

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

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

Goal name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

Goal type:
- `action`: JavaScript event.
- `chat`: Click on a chat.
- `email`: Click on an email address.
- `file`: File download.
- `messenger`: Click-through to a messenger.
- `number`: Number of views.
- `payment_system`: Payment system.
- `phone`: Click on a phone number.
- `search`: Site search.
- `social`: Click-through to social media.
- `step`: Multi-step goal.
- `url`: Pageviews.
- `visit_duration`: Session duration.


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

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

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

```json translate=no
[
  {
    "type": "example",
    "url": "example"
  }
]
```

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

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

Default goal cost.
{.table-cell}
||
||

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

Goal type for Yandex Market clients:
- `basket`: **Shopping cart**, shopping cart page.
- `order`: **Order**, order confirmation page.


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

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

ID of the goal. Specify this parameter when changing and deleting a tag goal.
{.table-cell}
||
||

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

Whether the goal is favorite:
- 0: False (default).
- 1: True.

{.table-cell}
||
||

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

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

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CompositeGoal {#entity-CompositeGoal}

Multi-step goal.
Used for grouping and setting the order of usual goals.
The "Page view" and "JavaScript event" goals can be steps of a multi-step goal.
A step is considered completed if all the previous steps were completed and all the current step's conditions were met.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  _Min items:_{.json-schema-reset .json-schema-assertion} `0`

  _Max items:_{.json-schema-reset .json-schema-assertion} `5`

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

  ```json translate=no
  [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
  ]
  ```

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

  {% endcut %}

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

  ```json translate=no
  {
    "steps": [
      {
        "id": 0,
        "name": "example",
        "type": "example",
        "default_price": 0.5,
        "is_favorite": true,
        "status": "example",
        "conditions": [
          {
            "type": "example",
            "url": "example"
          }
        ],
        "flag": "example"
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "steps": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {}
      ],
      "flag": "example"
    }
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DepthGoal {#entity-DepthGoal}

Page depth.
The goal is considered achieved if the user viewed the specified number of site pages.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  Number of pages viewed by the user.

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

  {% endcut %}

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

  ```json translate=no
  {
    "depth": 2
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "depth": 2
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### EmailGoal {#entity-EmailGoal}

Clicks or taps on an email address.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### FileGoal {#entity-FileGoal}

File download.
The goal is considered achieved if the user downloaded any file or a specific file.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### MessengerGoal {#entity-MessengerGoal}

Click-through to a messaging app.
The goal will be achieved once the user clicks the link to the messaging app.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PaymentSystemGoal {#entity-PaymentSystemGoal}

Payment systems.
The goal is considered achieved if the user makes a payment via a payment system.


{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PhoneGoal {#entity-PhoneGoal}

Clicks or taps on the phone number.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

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

  Hide the phone number on desktop devices.
  {.table-cell}
  ||
  |#{.json-schema-properties}

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example",
    "hide_phone_number": true
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example",
  "hide_phone_number": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### SiteSearchGoal {#entity-SiteSearchGoal}

Site search.
The goal will be achieved when performing a site search if there is at least one match in the URL specified in the GET parameters.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### SocialNetworkGoal {#entity-SocialNetworkGoal}

Click-through to a social network.
The goal will be achieved once the user clicks the link to the social network.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UrlGoal {#entity-UrlGoal}

Pageviews.
Achieved when at least one condition is met.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### VisitDurationGoal {#entity-VisitDurationGoal}

Session duration.
The goal will be achieved if the session duration exceeds the specified one.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  Session duration in seconds.

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

  {% endcut %}

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

  ```json translate=no
  {
    "duration": 1
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "duration": 1
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### FilterE {#entity-FilterE}

List of structures with information on tag filters.

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

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

Filter type:
- `exclude`: Exclude traffic.
- `include`: Leave only traffic.


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

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

Data type the filter is applied to:
- `title`: Page title.
- `client_ip`: IP address.
- `url`: Page URL.
- `referer`: Referrer.
- `uniq_id`: Special attribute for the **Don't count my sessions** filter.


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

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

Filter status:
- `active`: Filter is used.
- `disabled`: Filter disabled (but not deleted).


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

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

Filter type or action for filter:
- `equal`: Equal to.
- `start`: Starts with.
- `contain`: Contains.
- `interval`: In the interval, only used with the "IP address" data type (`attr = client_ip`).
- `me`: My visits, only used with the `attr = uniq_id` data type.
- `only_mirrors`: Only the site and its mirrors, used only for the Page URL data type (`attr = url`) and the **Leave only traffic** filter type (`action = include`), and provided that mirrors are specified for the tag.
- `regexp`: Regular expression.


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

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

The last IP address in the range.

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

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

Filter ID. Specify this parameter when changing a tag filter.
{.table-cell}
||
||

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

The first IP address in the range.

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

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

Filter value.

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

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

Filter by subdomain.
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "id": 0,
  "attr": "example",
  "type": "example",
  "value": "example",
  "action": "example",
  "status": "example",
  "start_ip": "example",
  "end_ip": "example",
  "with_subdomains": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OperationE {#entity-OperationE}

List of structures with information on tag actions.

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

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

Action type:
- `cut_fragment`: Remove an anchor from the URL.
- `cut_parameter`: Remove a specific parameter from the URL.
- `cut_all_parameters`: Remove all parameters from the URL.
- `merge_https_and_http`: Replace https:// with http://.
- `to_lower`: Convert to lower case.
- `replace_domain`: Replace a domain.


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

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

Field for filtering:
- `referer`: Referrer.
- `url`: Page URL.


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

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

Action status:
- `active`: Action is used.
- `disabled`: Action is disabled (but not deleted).


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

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

Action ID (needs to be specified while changing a tag action).
{.table-cell}
||
||

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

Value for replacement.

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

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

```json translate=no
{
  "id": 0,
  "action": "example",
  "attr": "example",
  "value": "example",
  "status": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CounterGrantE {#entity-CounterGrantE}

List of structures with information on access rights to the tag.

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

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

Access level:
- `public_stat`: Public access to statistics.
- `view`: Read only.
- `edit`: Full access.
- `analyst`: Analyst.
- `analyst_access_filter`: Data analyst with filter-based access.


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

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

Custom comment. The maximum number of characters is 255.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

_created_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date when the permission was granted in YYYY-MM-DD'T'hh:mm:ssZ format.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

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

Access to the Monetization report group. The user can view reports and add dimensions and metrics from the Monetization group to other reports.
Users with edit permissions already have access to the reports within the "Monetization" group.
Possible values:
- `true`: Access granted.
- `false`: Access denied.
{.table-cell}
||
||

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

Login of a user with tag management rights. This parameter contains an empty string if tag statistics are in public access (`perm = public_stat`).

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

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

```json translate=no
{
  "user_login": "example",
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "partner_data_access": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### AccessFiltersShortE {#entity-AccessFiltersShortE}

List of access filters granted to the user.

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

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

Access filter ID.
{.table-cell}
||
||

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

Access filter name.

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

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

```json translate=no
{
  "id": 0,
  "name": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### AccessFiltersGrantE {#entity-AccessFiltersGrantE}

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [CounterGrantE](#entity-CounterGrantE)

  List of structures with information on access rights to the tag.

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

  ```json translate=no
  {
    "user_login": "example",
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "partner_data_access": true
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  _Min items:_{.json-schema-reset .json-schema-assertion} `1`

  _Max items:_{.json-schema-reset .json-schema-assertion} `1`

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

  ```json translate=no
  [
    {
      "id": 0,
      "name": "example"
    }
  ]
  ```

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

  {% endcut %}

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

  ```json translate=no
  {
    "access_filters": [
      {
        "id": 0,
        "name": "example"
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "user_login": "example",
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "partner_data_access": true,
  "access_filters": [
    {
      "id": 0,
      "name": "example"
    }
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Label {#entity-Label}

Label.

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

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

Label ID.
{.table-cell}
||
||

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

Label name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

```json translate=no
{
  "id": 0,
  "name": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### WebvisorOptions {#entity-WebvisorOptions}

Structure with information on Session Replay settings.

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

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

Saving site pages:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Recording page content:
- `none`: Disabled.
- `load`: Download from site.
- `html`: From browser.


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

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

Loading pages in the player:
- `proxy`: As an anonymous user.
- `on_your_behalf`: As you.


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

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

List of pages for saving.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `2000`

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

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

Records the content of fields and forms:
- 0: Don't record the content of fields and forms, except those marked with the -metrika-recordkeys CSS class.
- 1: Record the content of fields and forms, except those marked with the -metrika-nokeys CSS class (default).

{.table-cell}
||
||

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

Session Replay version.
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "wv_forms": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### InformerOptionsE {#entity-InformerOptionsE}

Informer settings.

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

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

Color of the arrow in the informer:
- 0: Black.
- 1: Purple (default).


_Min value:_{.json-schema-reset .json-schema-assertion} `0`

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

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

End (bottom) color of the informer in RRGGBBAA format. This parameter is used to create a background gradient. You can set color saturation and transparency the same way as with the "color_start" parameter.

_Default:_{.json-schema-reset .json-schema-value} `EFEFEFFF`

_Pattern:_{.json-schema-reset .json-schema-assertion} `[0-9A-F]{8}`
{.table-cell}
||
||

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

The color at the top of the informer, specified in RRGGBBAA format. RR, GG, BB are saturated red, green, and blue colors. Saturation for each color is specified using a value from 00 to FF. AA: transparency, from 00 (transparent) to FF (opaque).

_Default:_{.json-schema-reset .json-schema-value} `FFFFFFFF.`

_Pattern:_{.json-schema-reset .json-schema-assertion} `[0-9A-F]{8}`
{.table-cell}
||
||

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

Color of the text in the informer:
- 0: Black (default).
- 1: White.


_Min value:_{.json-schema-reset .json-schema-assertion} `0`

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

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

Permission to display the informer:
- 0: Informer is not displayed (default).
- 1: Informer is displayed.

{.table-cell}
||
||

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

The parameter that will be shown on the informer:
- `pageviews`: Pageviews (default).
- `visits`: Sessions.
- `uniques`: Users.


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

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

Informer size:
- 1: 80×15
- 2: 80х31
- 3: 88×31 (default). The value in the `indicator` field doesn't change the appearance of this informer type.


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

_Max value:_{.json-schema-reset .json-schema-assertion} `3`
{.table-cell}
||
||

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

Informer type:
- `simple`: Simple.
- `ext`: Extended (default).


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

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

```json translate=no
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CodeOptionsE {#entity-CodeOptionsE}

Tag code settings.

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

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

This option ensures accurate tracking of sessions from regions where access to Yandex services is restricted. It might take longer to load the tag code when using this option:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Asynchronous tag code:
- 0: Disabled.
- 1: Enabled (default).

{.table-cell}
||
||

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

Gathering statistics for the Click Map report:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Collecting E-commerce data:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Print code snippet as a single string:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Informer settings.

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

```json translate=no
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}
```

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

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

Hash tracking in the browser address bar. The option applies to AJAX sites:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Record and analysis of site user behavior:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

For XML sites. The "noscript" element can't be used in XML documents:
- 0: Disabled (default).
- 1: Enabled.

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

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

```json translate=no
{
  "async": true,
  "informer": {
    "enabled": true,
    "type": "example",
    "size": 1,
    "indicator": "example",
    "color_start": "FFFFFFFF.",
    "color_end": "EFEFEFFF",
    "color_text": 0,
    "color_arrow": 0
  },
  "visor": true,
  "track_hash": true,
  "xml_site": true,
  "clickmap": true,
  "in_one_line": true,
  "ecommerce": true,
  "alternative_cdn": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PublisherOptions {#entity-PublisherOptions}

Structure with information on content analytics settings.

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

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

Collection of [content analytics](https://yandex.ru/support/metrica/publishers/about.html?lang=en) data.
To start collecting statistics, [add the markup to your site](https://yandex.ru/support/metrica/publishers/about.html?lang=en#about__how-to).
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Available site markup options. Possible values:

- `microdata`
- `json_ld`
- `opengraph`

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

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

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

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

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

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

```json translate=no
{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "example"
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CounterMirrorE {#entity-CounterMirrorE}

List of site mirrors (domains).

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

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

Full site domain.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

```json translate=no
{
  "site": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CounterFlags {#entity-CounterFlags}

Data security and usage.

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

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

Use advanced tracking settings.
Enabling this option will allow Yandex Metrica to use the contact information entered by users on the site to enhance advertising algorithms and more accurately analyze user behavior.
This helps you get better results from your ad campaigns and learn more about user behavior, even if they use browsers that limit cross-site cookies (third-party cookies), such as Safari and Mozilla Firefox.

{.table-cell}
||
||

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

Allow optimizing campaigns for goals without access to the counter.
If someone other than you manages your Yandex Direct ad campaigns, such as an agency or a setup expert, you can grant them permission to use existing goals in Yandex Metrica.
If the counter was created recently, the option is enabled by default. For more information, see [Help](https://yandex.ru/support/metrica/general/goals.html#?lang=engoals__direct).

{.table-cell}
||
||

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

Enable the [Measurement Protocol](https://yandex.com.tr/dev/metrika/en/data-import/measurement-about.md) option. The Measurement Protocol is an API for sending data about user interactions directly to Yandex Metrica servers via HTTP requests.
{.table-cell}
||
||

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

Get access to market reports. The option allows Yandex Metrica to use aggregated anonymized counter data to build market analytics reports.
The collected data will provide you with insights into your business's performance within the market.
If the counter was created recently, the option is enabled by default.

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

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

```json translate=no
{
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "collect_first_party_data": true,
  "measurement_enabled": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CounterFull {#entity-CounterFull}

Tag.

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

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

Counter traffic. Possible values:
- `low`: Low traffic.
- `high`: High traffic.


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

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

Enabling [automatic goals](https://yandex.com/support/metrica/general/auto-goals.html). Possible values:
- `true`: Option enabled.
- `false`: Option disabled.

{.table-cell}
||
||

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

HTML ad tag.

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

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

Tag code settings.

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

```json translate=no
{
  "async": true,
  "informer": {
    "enabled": true,
    "type": "example",
    "size": 1,
    "indicator": "example",
    "color_start": "FFFFFFFF.",
    "color_end": "EFEFEFFF",
    "color_text": 0,
    "color_arrow": 0
  },
  "visor": true,
  "track_hash": true,
  "xml_site": true,
  "clickmap": true,
  "in_one_line": true,
  "ecommerce": true,
  "alternative_cdn": true
}
```

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

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

Data security and usage.

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

```json translate=no
{
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "collect_first_party_data": true,
  "measurement_enabled": true
}
```

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

_create_time_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date and time when the tag was created.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

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

Time of tag deletion.

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

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

Whether the tag is added to favorites:
- 0: Not added (default).
- 1: Added.

{.table-cell}
||
||

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

Filtering of robots:
- 1: Filter robots by strict rules only (default).
- 2: Filter robots by strict rules and by behavior.


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

_Max value:_{.json-schema-reset .json-schema-assertion} `2`
{.table-cell}
||
||

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

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

```json translate=no
[
  {
    "id": 0,
    "attr": "example",
    "type": "example",
    "value": "example",
    "action": "example",
    "status": "example",
    "start_ip": "example",
    "end_ip": "example",
    "with_subdomains": true
  }
]
```

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

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

Acceptance of the [Yandex Metrica Data Processing Agreement](https://yandex.ru/legal/metrica_agreement/).
- 0: Agreement not accepted (default).
- 1: Agreement accepted.

{.table-cell}
||
||

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

{% cut "**One of 13 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [ActionGoal](#entity-ActionGoal)

  JavaScript event.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [ChatGoal](#entity-ChatGoal)

  Click or tap on a chat.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      null
    ]
  }
  ```

  {% endcut %}

- **Type**: [CompositeGoal](#entity-CompositeGoal)

  Multi-step goal.
  Used for grouping and setting the order of usual goals.
  The "Page view" and "JavaScript event" goals can be steps of a multi-step goal.
  A step is considered completed if all the previous steps were completed and all the current step's conditions were met.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "steps": [
      {
        "id": 0,
        "name": "example",
        "type": "example",
        "default_price": 0.5,
        "is_favorite": true,
        "status": "example",
        "conditions": [
          {}
        ],
        "flag": "example"
      }
    ]
  }
  ```

  {% endcut %}

- **Type**: [DepthGoal](#entity-DepthGoal)

  Page depth.
  The goal is considered achieved if the user viewed the specified number of site pages.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "depth": 2
  }
  ```

  {% endcut %}

- **Type**: [EmailGoal](#entity-EmailGoal)

  Clicks or taps on an email address.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [FileGoal](#entity-FileGoal)

  File download.
  The goal is considered achieved if the user downloaded any file or a specific file.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [MessengerGoal](#entity-MessengerGoal)

  Click-through to a messaging app.
  The goal will be achieved once the user clicks the link to the messaging app.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [PaymentSystemGoal](#entity-PaymentSystemGoal)

  Payment systems.
  The goal is considered achieved if the user makes a payment via a payment system.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- **Type**: [PhoneGoal](#entity-PhoneGoal)

  Clicks or taps on the phone number.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example",
    "hide_phone_number": true
  }
  ```

  {% endcut %}

- **Type**: [SiteSearchGoal](#entity-SiteSearchGoal)

  Site search.
  The goal will be achieved when performing a site search if there is at least one match in the URL specified in the GET parameters.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [SocialNetworkGoal](#entity-SocialNetworkGoal)

  Click-through to a social network.
  The goal will be achieved once the user clicks the link to the social network.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [UrlGoal](#entity-UrlGoal)

  Pageviews.
  Achieved when at least one condition is met.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [VisitDurationGoal](#entity-VisitDurationGoal)

  Session duration.
  The goal will be achieved if the session duration exceeds the specified one.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "duration": 1
  }
  ```

  {% endcut %}

{% endcut %}

{% endcut %}

List of structures with information on tag goals.

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

```json translate=no
[
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {}
    ],
    "flag": "example"
  }
]
```

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

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

{% cut "**One of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [CounterGrantE](#entity-CounterGrantE)

  List of structures with information on access rights to the tag.

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

  ```json translate=no
  {
    "user_login": "example",
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "partner_data_access": true
  }
  ```

  {% endcut %}

- **Type**: [AccessFiltersGrantE](#entity-AccessFiltersGrantE)

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

  ```json translate=no
  {
    "user_login": "example",
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "partner_data_access": true,
    "access_filters": [
      {
        "id": 0,
        "name": "example"
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

{% endcut %}

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

```json translate=no
[
  {
    "user_login": "example",
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "partner_data_access": true
  }
]
```

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

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

Tag ID.
{.table-cell}
||
||

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

List of structures with information on labels.

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

```json translate=no
[
  {
    "id": 0,
    "name": "example"
  }
]
```

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

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

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

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

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

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

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

```json translate=no
[
  {
    "site": "example"
  }
]
```

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

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

Tag name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

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

```json translate=no
[
  {
    "id": 0,
    "action": "example",
    "attr": "example",
    "value": "example",
    "status": "example"
  }
]
```

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

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

Login of the tag owner.

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

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

The Yandex Advertising Network site number if it is an affiliate counter.
{.table-cell}
||
||

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

Level of access to the tag:
- `own`: Tag belongs to the user.
- `view`: Tag with guest access level (**view only**).
- `edit`: Guest tag with **full access**.
- `analyst`: Guest tag with the **analytics** access level.
- `view_access_filter`: Guest tag with **access filter view only** access.
- `analyst_access_filter`: Guest tag with **access filter data analytics** access.


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

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

Structure with information on content analytics settings.

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

```json translate=no
{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "example"
  ]
}
```

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

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

List of site mirrors (domains).

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

```json translate=no
{
  "site": "example"
}
```

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

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

Counter status. Possible values:
- `Active`: Active tag.
- `Deleted`: Deleted tag.


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

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

[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for calculating statistics.

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

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

Current time zone offset from GMT (minutes).
{.table-cell}
||
||

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

Counter type. Possible values:
  - `simple`: Tag created by a user in Yandex Metrica.
  - `partner`: Tag imported from YAN.


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

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

Time of the last tag update.

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

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

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

Session timeout in seconds.

_Default:_{.json-schema-reset .json-schema-value} `1800`

_Min value:_{.json-schema-reset .json-schema-assertion} `1800`

_Max value:_{.json-schema-reset .json-schema-assertion} `21600`
{.table-cell}
||
||

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

Structure with information on Session Replay settings.

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

```json translate=no
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "wv_forms": true
}
```

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

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

```json translate=no
{
  "id": 0,
  "status": "example",
  "owner_login": "example",
  "activity_status": "example",
  "name": "example",
  "type": "example",
  "favorite": true,
  "permission": "example",
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "flag": "example"
    }
  ],
  "filters": [
    {
      "id": 0,
      "attr": "example",
      "type": "example",
      "value": "example",
      "action": "example",
      "status": "example",
      "start_ip": "example",
      "end_ip": "example",
      "with_subdomains": true
    }
  ],
  "operations": [
    {
      "id": 0,
      "action": "example",
      "attr": "example",
      "value": "example",
      "status": "example"
    }
  ],
  "grants": [
    {
      "user_login": "example",
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "partner_data_access": true
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "example"
    }
  ],
  "webvisor": {
    "urls": "example",
    "arch_enabled": true,
    "arch_type": "example",
    "load_player_type": "example",
    "wv_version": 0,
    "wv_forms": true
  },
  "code_options": {
    "async": true,
    "informer": {
      "enabled": true,
      "type": "example",
      "size": 1,
      "indicator": "example",
      "color_start": "FFFFFFFF.",
      "color_end": "EFEFEFFF",
      "color_text": 0,
      "color_arrow": 0
    },
    "visor": true,
    "track_hash": true,
    "xml_site": true,
    "clickmap": true,
    "in_one_line": true,
    "ecommerce": true,
    "alternative_cdn": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 0,
  "partner_id": 0,
  "update_time": "example",
  "delete_time": "example",
  "code": "example",
  "filter_robots": 1,
  "visit_threshold": 1800,
  "publisher_options": {
    "enabled": true,
    "schema": "example",
    "schema_options": [
      "example"
    ]
  },
  "vendor_id": 0,
  "site2": {
    "site": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "autogoals_enabled": true,
  "counter_flags": {
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "collect_first_party_data": true,
    "measurement_enabled": true
  },
  "measurement_tokens": [
    "example"
  ]
}
```

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "counter": {
    "id": 0,
    "status": "example",
    "owner_login": "example",
    "activity_status": "example",
    "name": "example",
    "type": "example",
    "favorite": true,
    "permission": "example",
    "goals": [
      null
    ],
    "filters": [
      {
        "id": 0,
        "attr": "example",
        "type": "example",
        "value": "example",
        "action": "example",
        "status": "example",
        "start_ip": "example",
        "end_ip": "example",
        "with_subdomains": true
      }
    ],
    "operations": [
      {
        "id": 0,
        "action": "example",
        "attr": "example",
        "value": "example",
        "status": "example"
      }
    ],
    "grants": [
      {
        "user_login": "example",
        "perm": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "comment": "example",
        "partner_data_access": true
      }
    ],
    "labels": [
      {
        "id": 0,
        "name": "example"
      }
    ],
    "webvisor": {
      "urls": "example",
      "arch_enabled": true,
      "arch_type": "example",
      "load_player_type": "example",
      "wv_version": 0,
      "wv_forms": true
    },
    "code_options": {
      "async": true,
      "informer": {
        "enabled": true,
        "type": "example",
        "size": 1,
        "indicator": "example",
        "color_start": "FFFFFFFF.",
        "color_end": "EFEFEFFF",
        "color_text": 0,
        "color_arrow": 0
      },
      "visor": true,
      "track_hash": true,
      "xml_site": true,
      "clickmap": true,
      "in_one_line": true,
      "ecommerce": true,
      "alternative_cdn": true,
      "ytm": true
    },
    "create_time": "2025-01-01T00:00:00Z",
    "time_zone_name": "example",
    "time_zone_offset": 0,
    "partner_id": 0,
    "source": "example",
    "update_time": "example",
    "delete_time": "example",
    "code": "example",
    "filter_robots": 1,
    "visit_threshold": 1800,
    "publisher_options": {
      "enabled": true,
      "schema": "example",
      "schema_options": [
        "example"
      ]
    },
    "vendor_id": 0,
    "site2": {
      "site": "example"
    },
    "gdpr_agreement_accepted": true,
    "mirrors2": [
      null
    ],
    "autogoals_enabled": true,
    "counter_flags": {
      "use_in_benchmarks": true,
      "direct_allow_use_goals_without_access": true,
      "collect_first_party_data": true,
      "measurement_enabled": true
    },
    "measurement_tokens": [
      "example"
    ]
  }
}
```

{% endcut %}

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

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

Tag.

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

```json translate=no
{
  "id": 0,
  "status": "example",
  "owner_login": "example",
  "activity_status": "example",
  "name": "example",
  "type": "example",
  "favorite": true,
  "permission": "example",
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "flag": "example"
    }
  ],
  "filters": [
    {
      "id": 0,
      "attr": "example",
      "type": "example",
      "value": "example",
      "action": "example",
      "status": "example",
      "start_ip": "example",
      "end_ip": "example",
      "with_subdomains": true
    }
  ],
  "operations": [
    {
      "id": 0,
      "action": "example",
      "attr": "example",
      "value": "example",
      "status": "example"
    }
  ],
  "grants": [
    {
      "user_login": "example",
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "partner_data_access": true
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "example"
    }
  ],
  "webvisor": {
    "urls": "example",
    "arch_enabled": true,
    "arch_type": "example",
    "load_player_type": "example",
    "wv_version": 0,
    "wv_forms": true
  },
  "code_options": {
    "async": true,
    "informer": {
      "enabled": true,
      "type": "example",
      "size": 1,
      "indicator": "example",
      "color_start": "FFFFFFFF.",
      "color_end": "EFEFEFFF",
      "color_text": 0,
      "color_arrow": 0
    },
    "visor": true,
    "track_hash": true,
    "xml_site": true,
    "clickmap": true,
    "in_one_line": true,
    "ecommerce": true,
    "alternative_cdn": true,
    "ytm": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 0,
  "partner_id": 0,
  "source": "example",
  "update_time": "example",
  "delete_time": "example",
  "code": "example",
  "filter_robots": 1,
  "visit_threshold": 1800,
  "publisher_options": {
    "enabled": true,
    "schema": "example",
    "schema_options": [
      "example"
    ]
  },
  "vendor_id": 0,
  "site2": {
    "site": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "autogoals_enabled": true,
  "counter_flags": {
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "collect_first_party_data": true,
    "measurement_enabled": true
  },
  "measurement_tokens": [
    "example"
  ]
}
```

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

</div>

<div class="openapi-entity">

### GoalE {#entity-GoalE1}

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

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

Goal name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

Goal type:
- `action`: JavaScript event.
- `chat`: Click on a chat.
- `email`: Click on an email address.
- `file`: File download.
- `messenger`: Click-through to a messenger.
- `number`: Number of views.
- `payment_system`: Payment system.
- `phone`: Click on a phone number.
- `search`: Site search.
- `social`: Click-through to social media.
- `step`: Multi-step goal.
- `url`: Pageviews.
- `visit_duration`: Session duration.


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

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

Default goal cost.
{.table-cell}
||
||

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

Indicates how the goal was created:
- `user`: The goal was created by a Yandex Metrica user.
- `auto`: The goal was created automatically. Such goals include [automatic goals](https://yandex.ru/support/metrica/general/auto-goals.html?lang=en) and the **Call** goal (created when [passing call data](https://yandex.com.tr/dev/metrika/en/management/calls.md)).


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

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

ID of the goal. Specify this parameter when changing and deleting a tag goal.
{.table-cell}
||
||

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

Whether the goal is favorite:
- 0: False (default).
- 1: True.

{.table-cell}
||
||

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

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

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ActionGoal {#entity-ActionGoal1}

JavaScript event.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ChatGoal {#entity-ChatGoal1}

Click or tap on a chat.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  {% cut "**One of 3 types**" %}{.json-schema-combinators data-marker=or}

  - **Type**: [ChatGoalConditionAnswered](#entity-ChatGoalConditionAnswered)

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

    ```json translate=no
    {
      "field": "example",
      "answered": true
    }
    ```

    {% endcut %}

  - **Type**: [ChatGoalConditionPlatform](#entity-ChatGoalConditionPlatform)

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

    ```json translate=no
    {
      "field": "example",
      "platform": "telegram"
    }
    ```

    {% endcut %}

  - **Type**: [ChatGoalConditionTag](#entity-ChatGoalConditionTag)

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

    ```json translate=no
    {
      "field": "example",
      "operator": "example",
      "value": "example"
    }
    ```

    {% endcut %}

  {% endcut %}

  {% endcut %}

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

  ```json translate=no
  [
    {
      "field": "example",
      "answered": true
    }
  ]
  ```

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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "field": "example",
        "answered": true
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    null
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ConditionalGoal {#entity-ConditionalGoal1}

List of steps in a multi-step goal.

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

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

Goal name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

Goal type:
- `action`: JavaScript event.
- `chat`: Click on a chat.
- `email`: Click on an email address.
- `file`: File download.
- `messenger`: Click-through to a messenger.
- `number`: Number of views.
- `payment_system`: Payment system.
- `phone`: Click on a phone number.
- `search`: Site search.
- `social`: Click-through to social media.
- `step`: Multi-step goal.
- `url`: Pageviews.
- `visit_duration`: Session duration.


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

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

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

```json translate=no
[
  {
    "type": "example",
    "url": "example"
  }
]
```

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

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

Default goal cost.
{.table-cell}
||
||

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

Goal type for Yandex Market clients:
- `basket`: **Shopping cart**, shopping cart page.
- `order`: **Order**, order confirmation page.


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

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

Indicates how the goal was created:
- `user`: The goal was created by a Yandex Metrica user.
- `auto`: The goal was created automatically. Such goals include [automatic goals](https://yandex.ru/support/metrica/general/auto-goals.html?lang=en) and the **Call** goal (created when [passing call data](https://yandex.com.tr/dev/metrika/en/management/calls.md)).


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

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

ID of the goal. Specify this parameter when changing and deleting a tag goal.
{.table-cell}
||
||

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

Whether the goal is favorite:
- 0: False (default).
- 1: True.

{.table-cell}
||
||

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

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

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CompositeGoal {#entity-CompositeGoal1}

Multi-step goal.
Used for grouping and setting the order of usual goals.
The "Page view" and "JavaScript event" goals can be steps of a multi-step goal.
A step is considered completed if all the previous steps were completed and all the current step's conditions were met.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  _Min items:_{.json-schema-reset .json-schema-assertion} `0`

  _Max items:_{.json-schema-reset .json-schema-assertion} `5`

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

  ```json translate=no
  [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
  ]
  ```

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

  {% endcut %}

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

  ```json translate=no
  {
    "steps": [
      {
        "id": 0,
        "name": "example",
        "type": "example",
        "default_price": 0.5,
        "goal_source": "example",
        "is_favorite": true,
        "status": "example",
        "conditions": [
          {
            "type": "example",
            "url": "example"
          }
        ],
        "flag": "example"
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "steps": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {}
      ],
      "flag": "example"
    }
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DepthGoal {#entity-DepthGoal1}

Page depth.
The goal is considered achieved if the user viewed the specified number of site pages.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  Number of pages viewed by the user.

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

  {% endcut %}

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

  ```json translate=no
  {
    "depth": 2
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "depth": 2
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### EmailGoal {#entity-EmailGoal1}

Clicks or taps on an email address.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### FileGoal {#entity-FileGoal1}

File download.
The goal is considered achieved if the user downloaded any file or a specific file.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### MessengerGoal {#entity-MessengerGoal1}

Click-through to a messaging app.
The goal will be achieved once the user clicks the link to the messaging app.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PaymentSystemGoal {#entity-PaymentSystemGoal1}

Payment systems.
The goal is considered achieved if the user makes a payment via a payment system.


{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PhoneGoal {#entity-PhoneGoal1}

Clicks or taps on the phone number.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

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

  Hide the phone number on desktop devices.
  {.table-cell}
  ||
  |#{.json-schema-properties}

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example",
    "hide_phone_number": true
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example",
  "hide_phone_number": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### SiteSearchGoal {#entity-SiteSearchGoal1}

Site search.
The goal will be achieved when performing a site search if there is at least one match in the URL specified in the GET parameters.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### SocialNetworkGoal {#entity-SocialNetworkGoal1}

Click-through to a social network.
The goal will be achieved once the user clicks the link to the social network.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UrlGoal {#entity-UrlGoal1}

Pageviews.
Achieved when at least one condition is met.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

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

  ```json translate=no
  [
    {
      "type": "example",
      "url": "example"
    }
  ]
  ```

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

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

  Goal type for Yandex Market clients:
  - `basket`: **Shopping cart**, shopping cart page.
  - `order`: **Order**, order confirmation page.


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

  {% endcut %}

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

  ```json translate=no
  {
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### VisitDurationGoal {#entity-VisitDurationGoal1}

Session duration.
The goal will be achieved if the session duration exceeds the specified one.


{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [GoalE](#entity-GoalE1)

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

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

  Session duration in seconds.

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

  {% endcut %}

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

  ```json translate=no
  {
    "duration": 1
  }
  ```

  {% endcut %}

{% endcut %}

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

```json translate=no
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "duration": 1
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CodeOptionsE {#entity-CodeOptionsE1}

Tag code settings.

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

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

This option ensures accurate tracking of sessions from regions where access to Yandex services is restricted. It might take longer to load the tag code when using this option:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Asynchronous tag code:
- 0: Disabled.
- 1: Enabled (default).

{.table-cell}
||
||

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

Gathering statistics for the Click Map report:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Collecting E-commerce data:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Print code snippet as a single string:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Informer settings.

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

```json translate=no
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}
```

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

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

Hash tracking in the browser address bar. The option applies to AJAX sites:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Record and analysis of site user behavior:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

For XML sites. The "noscript" element can't be used in XML documents:
- 0: Disabled (default).
- 1: Enabled.

{.table-cell}
||
||

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

Whether the tag management system is used. Possible values:
- 0: Not used.
- 1: Used.

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

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

```json translate=no
{
  "async": true,
  "informer": {
    "enabled": true,
    "type": "example",
    "size": 1,
    "indicator": "example",
    "color_start": "FFFFFFFF.",
    "color_end": "EFEFEFFF",
    "color_text": 0,
    "color_arrow": 0
  },
  "visor": true,
  "track_hash": true,
  "xml_site": true,
  "clickmap": true,
  "in_one_line": true,
  "ecommerce": true,
  "alternative_cdn": true,
  "ytm": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CounterFull {#entity-CounterFull1}

Tag.

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

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

Counter traffic. Possible values:
- `low`: Low traffic.
- `high`: High traffic.


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

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

Enabling [automatic goals](https://yandex.com/support/metrica/general/auto-goals.html). Possible values:
- `true`: Option enabled.
- `false`: Option disabled.

{.table-cell}
||
||

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

HTML ad tag.

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

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

Tag code settings.

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

```json translate=no
{
  "async": true,
  "informer": {
    "enabled": true,
    "type": "example",
    "size": 1,
    "indicator": "example",
    "color_start": "FFFFFFFF.",
    "color_end": "EFEFEFFF",
    "color_text": 0,
    "color_arrow": 0
  },
  "visor": true,
  "track_hash": true,
  "xml_site": true,
  "clickmap": true,
  "in_one_line": true,
  "ecommerce": true,
  "alternative_cdn": true,
  "ytm": true
}
```

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

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

Data security and usage.

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

```json translate=no
{
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "collect_first_party_data": true,
  "measurement_enabled": true
}
```

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

_create_time_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date and time when the tag was created.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

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

Time of tag deletion.

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

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

Whether the tag is added to favorites:
- 0: Not added (default).
- 1: Added.

{.table-cell}
||
||

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

Filtering of robots:
- 1: Filter robots by strict rules only (default).
- 2: Filter robots by strict rules and by behavior.


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

_Max value:_{.json-schema-reset .json-schema-assertion} `2`
{.table-cell}
||
||

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

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

```json translate=no
[
  {
    "id": 0,
    "attr": "example",
    "type": "example",
    "value": "example",
    "action": "example",
    "status": "example",
    "start_ip": "example",
    "end_ip": "example",
    "with_subdomains": true
  }
]
```

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

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

Acceptance of the [Yandex Metrica Data Processing Agreement](https://yandex.ru/legal/metrica_agreement/).
- 0: Agreement not accepted (default).
- 1: Agreement accepted.

{.table-cell}
||
||

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

{% cut "**One of 13 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [ActionGoal](#entity-ActionGoal1)

  JavaScript event.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [ChatGoal](#entity-ChatGoal1)

  Click or tap on a chat.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      null
    ]
  }
  ```

  {% endcut %}

- **Type**: [CompositeGoal](#entity-CompositeGoal1)

  Multi-step goal.
  Used for grouping and setting the order of usual goals.
  The "Page view" and "JavaScript event" goals can be steps of a multi-step goal.
  A step is considered completed if all the previous steps were completed and all the current step's conditions were met.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "steps": [
      {
        "id": 0,
        "name": "example",
        "type": "example",
        "default_price": 0.5,
        "goal_source": "example",
        "is_favorite": true,
        "status": "example",
        "conditions": [
          {}
        ],
        "flag": "example"
      }
    ]
  }
  ```

  {% endcut %}

- **Type**: [DepthGoal](#entity-DepthGoal1)

  Page depth.
  The goal is considered achieved if the user viewed the specified number of site pages.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "depth": 2
  }
  ```

  {% endcut %}

- **Type**: [EmailGoal](#entity-EmailGoal1)

  Clicks or taps on an email address.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [FileGoal](#entity-FileGoal1)

  File download.
  The goal is considered achieved if the user downloaded any file or a specific file.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [MessengerGoal](#entity-MessengerGoal1)

  Click-through to a messaging app.
  The goal will be achieved once the user clicks the link to the messaging app.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [PaymentSystemGoal](#entity-PaymentSystemGoal1)

  Payment systems.
  The goal is considered achieved if the user makes a payment via a payment system.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example"
  }
  ```

  {% endcut %}

- **Type**: [PhoneGoal](#entity-PhoneGoal1)

  Clicks or taps on the phone number.

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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example",
    "hide_phone_number": true
  }
  ```

  {% endcut %}

- **Type**: [SiteSearchGoal](#entity-SiteSearchGoal1)

  Site search.
  The goal will be achieved when performing a site search if there is at least one match in the URL specified in the GET parameters.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [SocialNetworkGoal](#entity-SocialNetworkGoal1)

  Click-through to a social network.
  The goal will be achieved once the user clicks the link to the social network.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [UrlGoal](#entity-UrlGoal1)

  Pageviews.
  Achieved when at least one condition is met.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "flag": "example"
  }
  ```

  {% endcut %}

- **Type**: [VisitDurationGoal](#entity-VisitDurationGoal1)

  Session duration.
  The goal will be achieved if the session duration exceeds the specified one.


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

  ```json translate=no
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "duration": 1
  }
  ```

  {% endcut %}

{% endcut %}

{% endcut %}

List of structures with information on tag goals.

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

```json translate=no
[
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {}
    ],
    "flag": "example"
  }
]
```

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

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

{% cut "**One of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [CounterGrantE](#entity-CounterGrantE)

  List of structures with information on access rights to the tag.

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

  ```json translate=no
  {
    "user_login": "example",
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "partner_data_access": true
  }
  ```

  {% endcut %}

- **Type**: [AccessFiltersGrantE](#entity-AccessFiltersGrantE)

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

  ```json translate=no
  {
    "user_login": "example",
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "partner_data_access": true,
    "access_filters": [
      {
        "id": 0,
        "name": "example"
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

{% endcut %}

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

```json translate=no
[
  {
    "user_login": "example",
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "partner_data_access": true
  }
]
```

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

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

Tag ID.
{.table-cell}
||
||

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

List of structures with information on labels.

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

```json translate=no
[
  {
    "id": 0,
    "name": "example"
  }
]
```

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

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

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

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

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

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

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

```json translate=no
[
  {
    "site": "example"
  }
]
```

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

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

Tag name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

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

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

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

```json translate=no
[
  {
    "id": 0,
    "action": "example",
    "attr": "example",
    "value": "example",
    "status": "example"
  }
]
```

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

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

Login of the tag owner.

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

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

The Yandex Advertising Network site number if it is an affiliate counter.
{.table-cell}
||
||

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

Level of access to the tag:
- `own`: Tag belongs to the user.
- `view`: Tag with guest access level (**view only**).
- `edit`: Guest tag with **full access**.
- `analyst`: Guest tag with the **analytics** access level.
- `view_access_filter`: Guest tag with **access filter view only** access.
- `analyst_access_filter`: Guest tag with **access filter data analytics** access.


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

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

Structure with information on content analytics settings.

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

```json translate=no
{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "example"
  ]
}
```

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

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

List of site mirrors (domains).

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

```json translate=no
{
  "site": "example"
}
```

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

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

Tag type. Possible values:
- `turbodirect`: Turbo Direct.
- `marketplace_direct`: Yandex Direct marketplaces.
- `sprav`: Yandex Business.
- `partner`: Yandex Advertising Network.
- `system`: System.
- `market`: Yandex Market.
- `eda`: Yandex Eats.
- `dzen`: Zen.
- `geoadv`: Advertising account.
- `games`: Yandex Games.


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

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

Counter status. Possible values:
- `Active`: Active tag.
- `Deleted`: Deleted tag.


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

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

[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for calculating statistics.

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

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

Current time zone offset from GMT (minutes).
{.table-cell}
||
||

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

Counter type. Possible values:
  - `simple`: Tag created by a user in Yandex Metrica.
  - `partner`: Tag imported from YAN.


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

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

Time of the last tag update.

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

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

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

Session timeout in seconds.

_Default:_{.json-schema-reset .json-schema-value} `1800`

_Min value:_{.json-schema-reset .json-schema-assertion} `1800`

_Max value:_{.json-schema-reset .json-schema-assertion} `21600`
{.table-cell}
||
||

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

Structure with information on Session Replay settings.

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

```json translate=no
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "wv_forms": true
}
```

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

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

```json translate=no
{
  "id": 0,
  "status": "example",
  "owner_login": "example",
  "activity_status": "example",
  "name": "example",
  "type": "example",
  "favorite": true,
  "permission": "example",
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "flag": "example"
    }
  ],
  "filters": [
    {
      "id": 0,
      "attr": "example",
      "type": "example",
      "value": "example",
      "action": "example",
      "status": "example",
      "start_ip": "example",
      "end_ip": "example",
      "with_subdomains": true
    }
  ],
  "operations": [
    {
      "id": 0,
      "action": "example",
      "attr": "example",
      "value": "example",
      "status": "example"
    }
  ],
  "grants": [
    {
      "user_login": "example",
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "partner_data_access": true
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "example"
    }
  ],
  "webvisor": {
    "urls": "example",
    "arch_enabled": true,
    "arch_type": "example",
    "load_player_type": "example",
    "wv_version": 0,
    "wv_forms": true
  },
  "code_options": {
    "async": true,
    "informer": {
      "enabled": true,
      "type": "example",
      "size": 1,
      "indicator": "example",
      "color_start": "FFFFFFFF.",
      "color_end": "EFEFEFFF",
      "color_text": 0,
      "color_arrow": 0
    },
    "visor": true,
    "track_hash": true,
    "xml_site": true,
    "clickmap": true,
    "in_one_line": true,
    "ecommerce": true,
    "alternative_cdn": true,
    "ytm": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 0,
  "partner_id": 0,
  "source": "example",
  "update_time": "example",
  "delete_time": "example",
  "code": "example",
  "filter_robots": 1,
  "visit_threshold": 1800,
  "publisher_options": {
    "enabled": true,
    "schema": "example",
    "schema_options": [
      "example"
    ]
  },
  "vendor_id": 0,
  "site2": {
    "site": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "autogoals_enabled": true,
  "counter_flags": {
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "collect_first_party_data": true,
    "measurement_enabled": true
  },
  "measurement_tokens": [
    "example"
  ]
}
```

{% endcut %}

</div>

</div>

</div>
<!-- endsource: en/management-src/Managing-counters/addCounter.md -->

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