Изменение счетчика

Изменяет указанный счетчик

Request

PUT

https://api-metrika.yandex.net/management/v1/counter/{counterId}

Path parameters

Name

Description

counterId

Type: integer

Идентификатор счетчика, информацию о котором вы хотите получить.

Query parameters

Name

Description

field

Type: string

Один или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: field=goals,mirrors,grants,filters,operation,counter_flags,measurement_tokens.

Example: ``

Body

application/json
{
  "counter": {
    "id": 0,
    "status": "example",
    "owner_login": "example",
    "activity_status": "example",
    "name": "example",
    "type": "example",
    "favorite": true,
    "hide_address": true,
    "pro": true,
    "pro_features": [
      "example"
    ],
    "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",
        "user_uid": 0,
        "perm": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "comment": "example",
        "email": "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,
      "ecommerce_object": "example",
      "ssr": true
    },
    "create_time": "2025-01-01T00:00:00Z",
    "time_zone_name": "example",
    "time_zone_offset": 0,
    "partner_id": 0,
    "title": "example",
    "grants_cnt": 0,
    "update_time": "example",
    "delete_time": "example",
    "code": "example",
    "filter_robots": 1,
    "currency": 0,
    "currency_code": "example",
    "visit_threshold": 1800,
    "max_goals": 0,
    "max_operations": 0,
    "max_filters": 0,
    "features": [
      "example"
    ],
    "publisher_options": {
      "enabled": true,
      "schema": "example",
      "schema_options": [
        "example"
      ]
    },
    "total_geo_points_count": 0,
    "selected_geo_points_count": 0,
    "vendor_id": 0,
    "mirrors_remove": 0,
    "goals_remove": 0,
    "filters_remove": 0,
    "operations_remove": 0,
    "grants_remove": 0,
    "site2": {
      "site": "example",
      "domain": "example",
      "status": "example"
    },
    "gdpr_agreement_accepted": true,
    "mirrors2": [
      null
    ],
    "cms": {
      "code": "example",
      "custom": "example"
    },
    "crm": {
      "code": "example",
      "custom": "example"
    },
    "communication_channel": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "industry": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "site_activity": {
      "code": "example",
      "custom": "example"
    },
    "user_activity": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "autogoals_enabled": true,
    "ecommerce_deduplicator_enabled": true,
    "counter_flags": {
      "counter_id": 0,
      "use_in_benchmarks": true,
      "direct_allow_use_goals_without_access": true,
      "incognito": "example",
      "collect_first_party_data": true,
      "collect_masked_first_party_data": true,
      "statistics_over_site": true,
      "measurement_enabled": true,
      "vendor_data": true,
      "allow_use_data_to_collect_feedback": true
    },
    "measurement_tokens": [
      "example"
    ]
  }
}

Name

Description

counter

Type: CounterEdit

Счетчик.

Example
{
  "id": 0,
  "status": "example",
  "owner_login": "example",
  "activity_status": "example",
  "name": "example",
  "type": "example",
  "favorite": true,
  "hide_address": true,
  "pro": true,
  "pro_features": [
    "example"
  ],
  "permission": "example",
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "prev_goal_id": 0,
      "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",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "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,
    "ecommerce_object": "example",
    "ssr": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 0,
  "partner_id": 0,
  "title": "example",
  "grants_cnt": 0,
  "update_time": "example",
  "delete_time": "example",
  "code": "example",
  "filter_robots": 1,
  "currency": 0,
  "currency_code": "example",
  "visit_threshold": 1800,
  "max_goals": 0,
  "max_operations": 0,
  "max_filters": 0,
  "features": [
    "example"
  ],
  "publisher_options": {
    "enabled": true,
    "schema": "example",
    "schema_options": [
      "example"
    ]
  },
  "total_geo_points_count": 0,
  "selected_geo_points_count": 0,
  "vendor_id": 0,
  "mirrors_remove": 0,
  "goals_remove": 0,
  "filters_remove": 0,
  "operations_remove": 0,
  "grants_remove": 0,
  "site2": {
    "site": "example",
    "domain": "example",
    "status": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "cms": {
    "code": "example",
    "custom": "example"
  },
  "crm": {
    "code": "example",
    "custom": "example"
  },
  "communication_channel": [
    {
      "code": "example",
      "custom": "example"
    }
  ],
  "industry": [
    {
      "code": "example",
      "custom": "example"
    }
  ],
  "site_activity": {
    "code": "example",
    "custom": "example"
  },
  "user_activity": [
    {
      "code": "example",
      "custom": "example"
    }
  ],
  "autogoals_enabled": true,
  "ecommerce_deduplicator_enabled": true,
  "counter_flags": {
    "counter_id": 0,
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "incognito": "example",
    "collect_first_party_data": true,
    "collect_masked_first_party_data": true,
    "statistics_over_site": true,
    "measurement_enabled": true,
    "vendor_data": true,
    "allow_use_data_to_collect_feedback": true
  },
  "measurement_tokens": [
    "example"
  ]
}

GoalE

Name

Description

name

Type: string

Наименование цели.

Min length: 0

Max length: 255

Example: example

type

Type: string

Тип цели:

  • action — JavaScript-событие.
  • chat — клик по чату.
  • email — клик по email.
  • file — скачивание файлов.
  • messenger — переход в мессенджер.
  • number — количество просмотров.
  • payment_system — платежная система.
  • phone — клик по номеру телефона.
  • search — поиск по сайту.
  • social — переход в соцсети.
  • step — составная цель.
  • url — посещение страниц.
  • visit_duration — продолжительность визита.

Example: example

default_price

Type: number

Цена цели по умолчанию.

id

Type: integer

Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.

is_favorite

Type: boolean

Является ли цель избранной:

  • 0 ― не является (по умолчанию).
  • 1 ― является.

status

Type: string

Example: example

Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example"
}

GoalCondition

Список структур с условиями цели.

Name

Description

type

Type: string

Тип условия:

  • contain — содержит;
  • exact — совпадает;
  • start — начинается с;
  • regexp — удовлетворяет регулярному выражению;
  • action — специальный тип условия для целей «JavaScript-событие»;
  • messenger — специальный тип условия для целей типа form, путь в dom дереве;
  • all_files — признак для целей «Переход в мессенджер»;
  • file — скачивание конкретного файла для целей «Скачивание файлов»;
  • search — признак для целей «Поиск по сайту»;
  • all_social — специальный тип условия для целей типа social (все социальные сети);
  • social — специальный тип условия для целей типа social (конкретная социальная сеть);
  • regexp_action — js-событие удовлетворяет регулярному выражению (используется только в шаге составной цели);
  • contain_action — js-событие содержит (используется только в шаге составной цели).

Example: example

url

Type: string

Значение зависит от типа цели:

  • Посещение страниц. Адрес страницы или части страницы для условия.
  • Клик по email или Клик по номеру телефона. Email или номер телефона, который указан в ссылках на сайте. Подробнее о том, как отследить клик по email или номеру телефона.
  • Переход в мессенджер. Название мессенджера, полученное с помощью метода GET management/v1/messengers, или значение all_messengers.
  • Поиск по сайту. GET-параметр, который используется для поиска на сайте. Метрика автоматически распознает параметры q, text, query или search. Если на сайте используется другой параметр, укажите его в запросе.
  • Скачивание файлов. Имя файла, например example.pdf. Значение может быть пустым, если нужно отслеживать скачивание всех файлов на сайте.
  • Переход в социальную сеть. Название социальной сети, полученное с помощью метода GET management/v1/social_networks, или значение all_social.

Example: example

Example
{
  "type": "example",
  "url": "example"
}

ActionGoal

JavaScript-событие.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

ChatGoalCondition

Список структур с условиями цели.

Name

Description

field

Type: string

К чему применять цель.

Example: example

Example
{
  "field": "example"
}

ChatGoalConditionAnswered

All of 2 types
  • Type: ChatGoalCondition

    Список структур с условиями цели.

    Example
    {
      "field": "example"
    }
    
  • Type: object

    answered

    Type: boolean

    Статус ответа в чате.

    Example
    {
      "answered": true
    }
    
Example
{
  "field": "example",
  "answered": true
}

ChatGoalConditionPlatform

All of 2 types
  • Type: ChatGoalCondition

    Список структур с условиями цели.

    Example
    {
      "field": "example"
    }
    
  • Type: object

    platform

    Type: string

    Платформа чата. Возможные значения:

    • telegram;
    • viber;
    • whatsApp.

    Example: telegram

    Example
    {
      "platform": "telegram"
    }
    
Example
{
  "field": "example",
  "platform": "telegram"
}

ChatGoalConditionTag

All of 2 types
  • Type: ChatGoalCondition

    Список структур с условиями цели.

    Example
    {
      "field": "example"
    }
    
  • Type: object

    operator

    Type: string

    Тип условия. Возможные значения:

    • contain — содержит.
    • exact — совпадает.
    • start — начинается с.
    • regexp — удовлетворяет регулярному выражению.

    Example: example

    value

    Type: string

    Min length: 1

    Max length: 1024

    Example: example

    Example
    {
      "operator": "example",
      "value": "example"
    }
    
Example
{
  "field": "example",
  "operator": "example",
  "value": "example"
}

ChatGoal

Нажатие на чат.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: array
    One of 3 types
    Example
    [
      {
        "field": "example",
        "answered": true
      }
    ]
    
    Example
    {
      "conditions": [
        {
          "field": "example",
          "answered": true
        }
      ]
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    null
  ]
}

ConditionalGoal

Список шагов составной цели.

Name

Description

name

Type: string

Наименование цели.

Min length: 0

Max length: 255

Example: example

type

Type: string

Тип цели:

  • action — JavaScript-событие.
  • chat — клик по чату.
  • email — клик по email.
  • file — скачивание файлов.
  • messenger — переход в мессенджер.
  • number — количество просмотров.
  • payment_system — платежная система.
  • phone — клик по номеру телефона.
  • search — поиск по сайту.
  • social — переход в соцсети.
  • step — составная цель.
  • url — посещение страниц.
  • visit_duration — продолжительность визита.

Example: example

conditions

Type: GoalCondition[]

Example
[
  {
    "type": "example",
    "url": "example"
  }
]

default_price

Type: number

Цена цели по умолчанию.

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basketкорзина, страница посещения корзины.
  • orderзаказ, страница подтверждения заказа.

Example: example

id

Type: integer

Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.

is_favorite

Type: boolean

Является ли цель избранной:

  • 0 ― не является (по умолчанию).
  • 1 ― является.

status

Type: string

Example: example

Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

CompositeGoal

Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    steps

    Type: ConditionalGoal[]

    Min items: 0

    Max items: 5

    Example
    [
      {
        "id": 0,
        "name": "example",
        "type": "example",
        "default_price": 0.5,
        "is_retargeting": true,
        "is_favorite": true,
        "status": "example",
        "conditions": [
          {
            "type": "example",
            "url": "example"
          }
        ],
        "prev_goal_id": 0,
        "flag": "example"
      }
    ]
    
    Example
    {
      "steps": [
        {
          "id": 0,
          "name": "example",
          "type": "example",
          "default_price": 0.5,
          "is_retargeting": true,
          "is_favorite": true,
          "status": "example",
          "conditions": [
            {
              "type": "example",
              "url": "example"
            }
          ],
          "prev_goal_id": 0,
          "flag": "example"
        }
      ]
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "steps": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {}
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
  ]
}

DepthGoal

Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    depth

    Type: integer

    Количество просмотренных пользователем страниц.

    Min value: 2

    Example
    {
      "depth": 2
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "depth": 2
}

EmailGoal

Нажатие на email.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

FileGoal

Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

MessengerGoal

Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

PaymentSystemGoal

Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.

All of 1 type
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example"
}

PhoneGoal

Нажатие на номер телефона.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    hide_phone_number

    Type: boolean

    Скрывать номер телефона на десктопах.

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example",
      "hide_phone_number": true
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example",
  "hide_phone_number": true
}

SiteSearchGoal

Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

SocialNetworkGoal

Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

UrlGoal

Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

VisitDurationGoal

Продолжительность визита. Цель будет достигнута при времени визита больше заданного.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    duration

    Type: integer

    Продолжительность визита в секундах.

    Min value: 1

    Example
    {
      "duration": 1
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "is_favorite": true,
  "status": "example",
  "duration": 1
}

FilterE

Список структур с информацией о фильтрах счетчика.

Name

Description

action

Type: string

Тип фильтра:

  • exclude — исключить трафик.
  • include — оставить только трафик.

Example: example

attr

Type: string

Тип данных, к которым применяется фильтр:

  • title — заголовок страницы.
  • client_ip — IP-адрес.
  • url — URL страницы.
  • referer — реферер.
  • uniq_id — специальный атрибут для фильтра не учитывать мои визиты.

Example: example

status

Type: string

Статус фильтра:

  • active — фильтр используется.
  • disabled — фильтр отключен (без удаления).

Example: example

type

Type: string

Отношение или действие для фильтра:

  • equal — равно.
  • start — начинается с.
  • contain — содержит.
  • interval — в интервале, используется только с типом данных «IP-адрес» (attr = client_ip).
  • me — мои посещения, используется только с типом данных attr = uniq_id.
  • only_mirrors — только сайт и зеркала, используется только для типа данных «URL страницы» (attr = url) и типа фильтра оставить только трафик (action = include), а также при условии, что для счетчика заданы зеркала.
  • regexp — регулярное выражение.

Example: example

end_ip

Type: string

Последний IP-адрес диапазона.

Example: example

id

Type: integer

Идентификатор фильтра. Укажите данный параметр при изменении фильтра счетчика.

start_ip

Type: string

Первый IP-адрес диапазона.

Example: example

value

Type: string

Значение фильтра.

Example: example

with_subdomains

Type: boolean

Фильтровать по поддоменам.

Example
{
  "id": 0,
  "attr": "example",
  "type": "example",
  "value": "example",
  "action": "example",
  "status": "example",
  "start_ip": "example",
  "end_ip": "example",
  "with_subdomains": true
}

OperationE

Список структур с информацией об операциях счетчика.

Name

Description

action

Type: string

Тип операции:

  • cut_fragment — вырезать якорь из URL.
  • cut_parameter — вырезать определенный параметр из URL.
  • cut_all_parameters — вырезать все параметры из URL.
  • merge_https_and_http — заменить https:// на http://.
  • to_lower — привести к нижнему регистру.
  • replace_domain — заменить домен.

Example: example

attr

Type: string

Поле для фильтрации:

  • referer — реферер.
  • url — URL страницы.

Example: example

status

Type: string

Статус операции:

  • active — операция используется.
  • disabled — операция отключена (без удаления).

Example: example

id

Type: integer

Идентификатор операции (требуется указывать при изменении операции счетчика).

value

Type: string

Значение для замены.

Example: example

Example
{
  "id": 0,
  "action": "example",
  "attr": "example",
  "value": "example",
  "status": "example"
}

CounterGrantE

Список структур с информацией о правах доступа к счетчику.

Name

Description

perm

Type: string

Уровень доступа:

  • public_stat — публичный доступ к статистике.
  • view — только просмотр.
  • edit — полный доступ.
  • analyst — аналитик.
  • analyst_access_filter — аналитик данных через фильтр.

Example: example

comment

Type: string

Произвольный комментарий. Количество символов не должно превышать 255.

Min length: 0

Max length: 255

Example: example

created_at

Type: string<date-time>

Дата предоставления доступа в формате YYYY-MM-DD'T'hh:mm:ssZ.

Example: 2025-01-01T00:00:00Z

partner_data_access

Type: boolean

Доступ к группе отчетов «Монетизация». Пользователь сможет просматривать отчеты, добавлять группировки и метрики из группы «Монетизация» в другие отчеты. Если у пользователя есть доступ на редактирование, то ему уже доступны отчеты группы «Монетизация». Возможные значения:

  • true — доступ разрешен;
  • false — доступ не разрешен.

user_login

Type: string

Логин пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит пустую строку, если к статистике счетчика предоставлен публичный доступ (perm = public_stat).

Example: example

Example
{
  "user_login": "example",
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "partner_data_access": true
}

AccessFiltersShortE

Список фильтров доступа, к которым выдано разрешение.

Name

Description

id

Type: integer

id фильтра доступа.

name

Type: string

Название фильтра доступа.

Example: example

Example
{
  "id": 0,
  "name": "example"
}

AccessFiltersGrantE

All of 2 types
  • Type: CounterGrantE

    Список структур с информацией о правах доступа к счетчику.

    Example
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true
    }
    
  • Type: object

    access_filters

    Type: AccessFiltersShortE[]

    Min items: 1

    Max items: 1

    Example
    [
      {
        "id": 0,
        "name": "example"
      }
    ]
    
    Example
    {
      "access_filters": [
        {
          "id": 0,
          "name": "example"
        }
      ]
    }
    
Example
{
  "user_login": "example",
  "user_uid": 0,
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "email": "example",
  "partner_data_access": true,
  "access_filters": [
    {
      "id": 0,
      "name": "example"
    }
  ]
}

Label

Метка.

Name

Description

id

Type: integer

Идентификатор метки.

name

Type: string

Имя метки.

Min length: 0

Max length: 255

Example: example

Example
{
  "id": 0,
  "name": "example"
}

WebvisorOptions

Структура с информацией о настройках Вебвизора.

Name

Description

arch_enabled

Type: boolean

Сохранение страниц сайта:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

arch_type

Type: string

Запись содержимого страниц:

  • none — выключено.
  • load — загружать с сайта.
  • html — из браузера.

Example: example

load_player_type

Type: string

Загрузка страниц в плеер:

  • proxy — от имени анонимного пользователя.
  • on_your_behalf — от вашего имени.

Example: example

urls

Type: string

Список страниц для сохранения.

Min length: 0

Max length: 2000

Example: example

wv_forms

Type: boolean

Запись содержимого полей и форм:

  • 0 — не записывать содержимое полей и форм за исключением тех из них, которые помечены css-классом -metrika-recordkeys.
  • 1 — записывать содержимое полей и форм за исключением тех из них, которые помечены css-классом -metrika-nokeys (по умолчанию).

wv_version

Type: integer

Версия вебвизора.

Example
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "wv_forms": true
}

InformerOptionsE

Настройки информера.

Name

Description

color_arrow

Type: integer

Цвет стрелки на информере:

  • 0 ― черный;
  • 1 ― фиолетовый (по умолчанию).

Min value: 0

Max value: 1

color_end

Type: string

Конечный (нижний) цвет информера в формате RRGGBBAA. Параметр предназначен для создания градиента фона. Насыщенность и прозрачность цвета задаются аналогично параметру color_start.

Default: EFEFEFFF

Pattern: [0-9A-F]{8}

color_start

Type: string

Начальный (верхний) цвет информера в формате RRGGBBAA. RR, GG, BB ― насыщенность красного, зеленого и синего цвета. Насыщенность каждого цвета задается значениями в диапазоне от 00 до FF. AA ― прозрачность от 00 (прозрачный) до FF (непрозрачный).

Default: FFFFFFFF.

Pattern: [0-9A-F]{8}

color_text

Type: integer

Цвет текста на информере:

  • 0 ― черный (по умолчанию);
  • 1 ― белый.

Min value: 0

Max value: 1

enabled

Type: boolean

Разрешение отображения информера:

  • 0 ― информер не отображается (по умолчанию).
  • 1 ― информер отображается.

indicator

Type: string

Показатель, который будет отображаться на информере:

  • pageviews — просмотры (по умолчанию).
  • visits — визиты.
  • uniques — посетители.

Example: example

size

Type: integer

Размер информера:

  • 1 — размер 80х15;
  • 2 — размер 80х31;
  • 3 — размер 88х31 (по умолчанию). На вид информера этого типа не влияет значение поля indicator.

Min value: 1

Max value: 3

type

Type: string

Тип информера:

  • simple — простой.
  • ext — расширенный (по умолчанию).

Example: example

Example
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}

CodeOptionsE

Настройки кода счетчика.

Name

Description

alternative_cdn

Type: boolean

Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

async

Type: boolean

Асинхронный код счетчика:

  • 0 ― отключено.
  • 1 ― включено (по умолчанию).

clickmap

Type: boolean

Сбор статистики для работы отчета Карта кликов:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

ecommerce

Type: boolean

Сбор данных по электронной коммерции:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

in_one_line

Type: boolean

Выводить код счетчика в одну строку:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

informer

Type: InformerOptionsE

Настройки информера.

Example
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}

track_hash

Type: boolean

Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

visor

Type: boolean

Запись и анализ поведения посетителей сайта:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

xml_site

Type: boolean

Для XML-сайтов. Элемент noscript не должен использоваться в XML документах:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

Example
{
  "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
}

PublisherOptions

Структура с информацией о настройках контентной аналитики.

Name

Description

enabled

Type: boolean

Сбор данных контентной аналитики. Для начала сбора статистики нужно добавить на сайт разметку.

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

schema

Type: string

Доступные варианты разметки сайта. Возможные значения:

  • microdata.
  • json_ld.
  • opengraph.

Example: example

schema_options

Type: string[]

Example
[
  "example"
]
Example
{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "example"
  ]
}

CounterMirrorE

Список зеркал (доменов) сайта.

Name

Description

site

Type: string

Полный домен сайта.

Min length: 0

Max length: 255

Example: example

Example
{
  "site": "example"
}

CounterCms

CMS система счетчика. Возможные значения поля code:

  • bitrix24 — Битрикс24.
  • flexbe — Flexbe.
  • joomla — Joomla.
  • drupal — Drupal.
  • opencart — OpenCart.
  • tilda — Tilda.
  • webasyst — Webasyst.
  • wix — Wix.
  • wordpress — Wordpress.
  • insales — Insales.
  • nethouse — Nethouse. Также можно передать пользовательское значение в поле custom размером не более 128 символов.

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 128

Example: example

Example
{
  "code": "example",
  "custom": "example"
}

CounterCrm

CRM система счетчика. Возможные значения поля code:

  • amocrm — AmoCRM.
  • bitrix24 — Битрикс24.
  • megaplan — Мегаплан.
  • crm_1c — 1С:CRM.
  • moysklad — Мой склад.
  • yclients — Yclients.
  • retailcrm — RetailCRM. Также можно передать пользовательское значение в поле custom размером не более 128 символов.

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 128

Example: example

Example
{
  "code": "example",
  "custom": "example"
}

SiteActivityProfile

Профиль активности счетчика. Возможные значения поля code:

  • retail- Интернет-магазин.
  • promo_site- Промо-сайт.
  • online_service- Облачное приложение.
  • text_site- Информационный сайт. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example

Example
{
  "code": "example",
  "custom": "example"
}

CounterFlags

Безопасность и использование данных.

Name

Description

collect_first_party_data

Type: boolean

Использовать дополнительные настройки отслеживания. Опция разрешает Метрике использовать введенные посетителем контактные данные с сайта для улучшения работы рекламных алгоритмов и более точного анализа поведения посетителей сайта. Это поможет вам повышать эффективность рекламных кампаний и узнавать больше о поведении посетителей, даже если они используют браузеры с ограничением межсайтовых cookies (third-party cookies) — например, Safari или Mozilla Firefox.

direct_allow_use_goals_without_access

Type: boolean

Разрешить в рекламных кампаниях оптимизацию по целям без доступа к счетчику. Если управлением ваших рекламных кампаний в Директе занимается кто-то кроме вас, например, агентство или специалист по настройке, вы можете дать разрешение на использование существующих в Метрике целей. Если счетчик создан недавно, опция включена по умолчанию. Подробно см. в Справке.

measurement_enabled

Type: boolean

Включить опцию Measurement Protocol. Measurement Protocol — API для отправки данных о взаимодействиях пользователей напрямую на сервера Метрики через HTTP-запросы.

use_in_benchmarks

Type: boolean

Получать доступ к отчетам по рынку. Опция разрешает Метрике использовать агрегированные обезличенные данные счетчика для построения отчетов по аналитике рынка. Собираемые данные дадут вам возможность понимать состояние своего бизнеса относительно рынка. Если счетчик создан недавно, опция включена по умолчанию.

Example
{
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "collect_first_party_data": true,
  "measurement_enabled": true
}

LocationOnPage

Name

Description

path

Type: string

Местоположение на странице

Min length: 0

Max length: 4096

Example: example

type_of_path

Type: string

Тип указанного местоположения

Example: example

Example
{
  "type_of_path": "example",
  "path": "example"
}

CounterEdit

Счетчик.

Name

Description

activity_status

Type: string

Посещаемость счетчика. Возможные значения:

  • low — низкая посещаемость.
  • high — высокая посещаемость.

Example: example

autogoals_enabled

Type: boolean

Включение автоматических целей. Возможные значения:

  • true — опция включена.
  • false — опция выключена.

cms

Type: CounterCms

CMS система счетчика. Возможные значения поля code:

  • bitrix24 — Битрикс24.
  • flexbe — Flexbe.
  • joomla — Joomla.
  • drupal — Drupal.
  • opencart — OpenCart.
  • tilda — Tilda.
  • webasyst — Webasyst.
  • wix — Wix.
  • wordpress — Wordpress.
  • insales — Insales.
  • nethouse — Nethouse. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
Example
{
  "code": "example",
  "custom": "example"
}

code

Type: string

HTML-код вставки.

Example: example

code_options

Type: CodeOptionsE

Настройки кода счетчика.

Example
{
  "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,
  "ecommerce_object": "example",
  "ssr": true
}

counter_flags

Type: CounterFlags

Безопасность и использование данных.

Example
{
  "counter_id": 0,
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "incognito": "example",
  "collect_first_party_data": true,
  "collect_masked_first_party_data": true,
  "statistics_over_site": true,
  "measurement_enabled": true,
  "vendor_data": true,
  "allow_use_data_to_collect_feedback": true
}

create_time

Type: string<date-time>

Дата и время создания счетчика.

Example: 2025-01-01T00:00:00Z

crm

Type: CounterCrm

CRM система счетчика. Возможные значения поля code:

  • amocrm — AmoCRM.
  • bitrix24 — Битрикс24.
  • megaplan — Мегаплан.
  • crm_1c — 1С:CRM.
  • moysklad — Мой склад.
  • yclients — Yclients.
  • retailcrm — RetailCRM. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
Example
{
  "code": "example",
  "custom": "example"
}

delete_time

Type: string

Время удаления счетчика.

Example: example

favorite

Type: boolean

Добавлен ли счетчик в избранное:

  • 0 ― не добавлен (по умолчанию);
  • 1 ― добавлен.

filter_robots

Type: integer

Фильтрация роботов:

  • 1 — фильтровать роботов только по строгим правилам (по умолчанию);
  • 2 — фильтровать роботов по строгим правилам и по поведению.

Min value: 1

Max value: 2

filters

Type: FilterE[]

Example
[
  {
    "id": 0,
    "attr": "example",
    "type": "example",
    "value": "example",
    "action": "example",
    "status": "example",
    "start_ip": "example",
    "end_ip": "example",
    "with_subdomains": true
  }
]

filters_remove

Type: integer

Нужно ли удалить фильтры:

  • 0 — не удалять фильтры (по умолчанию);
  • 1 — игнорировать входящий параметр filters (если указан), а также удалить ранее заданные фильтры счетчика.

gdpr_agreement_accepted

Type: boolean

Согласие с Договором об обработке данных в сервисе Яндекс Метрика.

  • 0 — договор не принят (по умолчанию).
  • 1 — договор принят.

goals

Type: array
One of 13 types
  • Type: ActionGoal

    JavaScript-событие.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: ChatGoal

    Нажатие на чат.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ]
    }
    
  • Type: CompositeGoal

    Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "steps": [
        {
          "id": 0,
          "name": "example",
          "type": "example",
          "default_price": 0.5,
          "is_retargeting": true,
          "is_favorite": true,
          "status": "example",
          "conditions": [
            {}
          ],
          "prev_goal_id": 0,
          "flag": "example"
        }
      ]
    }
    
  • Type: DepthGoal

    Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "depth": 2
    }
    
  • Type: EmailGoal

    Нажатие на email.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: FileGoal

    Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: MessengerGoal

    Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: PaymentSystemGoal

    Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: PhoneGoal

    Нажатие на номер телефона.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example",
      "hide_phone_number": true
    }
    
  • Type: SiteSearchGoal

    Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: SocialNetworkGoal

    Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: UrlGoal

    Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example",
      "price_locations": [
        {
          "type_of_path": "example",
          "path": "example"
        }
      ]
    }
    
  • Type: VisitDurationGoal

    Продолжительность визита. Цель будет достигнута при времени визита больше заданного.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "duration": 1
    }
    

Список структур с информацией о целях счетчика.

Example
[
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_retargeting": true,
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {}
    ],
    "prev_goal_id": 0,
    "flag": "example"
  }
]

goals_remove

Type: integer

Нужно ли удалить цели:

  • 0 — не удалять цели (по умолчанию);
  • 1 — игнорировать входящий параметр goals (если указан), а также удалить для счетчика ранее заданные цели.

grants

Type: array
One of 2 types
  • Type: CounterGrantE

    Список структур с информацией о правах доступа к счетчику.

    Example
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true
    }
    
  • Type: AccessFiltersGrantE

    Example
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true,
      "access_filters": [
        {
          "id": 0,
          "name": "example"
        }
      ]
    }
    
Example
[
  {
    "user_login": "example",
    "user_uid": 0,
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "email": "example",
    "partner_data_access": true
  }
]

grants_remove

Type: integer

Нужно ли удалить настройки доступа:

  • 0 — не удалять настройки доступа (по умолчанию);
  • 1 — игнорировать входящий параметр grants (если указан), а также удалить для счетчика ранее заданные настройки доступа.

id

Type: integer

Идентификатор счетчика.

labels

Type: Label[]

Список структур с информацией о метках.

Example
[
  {
    "id": 0,
    "name": "example"
  }
]

measurement_tokens

Type: string[]

Example
[
  "example"
]

mirrors_remove

Type: integer

Нужно ли удалить зеркала:

  • 0 — не удалять зеркала (по умолчанию);
  • 1 — игнорировать входящий параметр mirrors (если указан), а также удалить для счетчика ранее заданные зеркала сайта.

mirrors2

Type: CounterMirrorE[]

Example
[
  {
    "site": "example",
    "domain": "example",
    "status": "example"
  }
]

name

Type: string

Наименование счетчика.

Min length: 0

Max length: 255

Example: example

operations

Type: OperationE[]

Example
[
  {
    "id": 0,
    "action": "example",
    "attr": "example",
    "value": "example",
    "status": "example"
  }
]

operations_remove

Type: integer

Нужно ли удалить операции:

  • 0 — не удалять операции (по умолчанию);
  • 1 — игнорировать входящий параметр operations (если указан), а также удалить ранее заданные операции счетчика.

owner_login

Type: string

Логин владельца счетчика.

Example: example

permission

Type: string

Уровень доступа к счетчику:

  • own — счетчик, принадлежащий пользователю.
  • view — гостевой счетчик с уровнем доступа только просмотр.
  • edit — гостевой счетчик с уровнем доступа полный доступ.
  • analyst — гостевой счетчик с уровнем доступа аналитика.
  • view_access_filter — гостевой счетчик с уровнем доступа только просмотр через фильтр доступа.
  • analyst_access_filter — гостевой счетчик с уровнем доступа аналитика данных через фильтр доступа.

Example: example

publisher_options

Type: PublisherOptions

Структура с информацией о настройках контентной аналитики.

Example
{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "example"
  ]
}

site_activity

Type: SiteActivityProfile

Профиль активности счетчика. Возможные значения поля code:

  • retail- Интернет-магазин.
  • promo_site- Промо-сайт.
  • online_service- Облачное приложение.
  • text_site- Информационный сайт. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.
Example
{
  "code": "example",
  "custom": "example"
}

site2

Type: CounterMirrorE

Список зеркал (доменов) сайта.

Example
{
  "site": "example",
  "domain": "example",
  "status": "example"
}

status

Type: string

Статус счетчика. возможные значения:

  • Active — счетчик активен.
  • Deleted — счетчик удален.

Example: example

time_zone_name

Type: string

Часовой пояс для расчета статистики.

Example: example

time_zone_offset

Type: integer

Текущее смещение часового пояса от Гринвича, минуты.

type

Type: string

Тип счетчика. Возможные значения:

  • simple — счетчик создан пользователем в Яндекс Метрике.
  • partner — счетчик импортирован из РСЯ.

Example: example

update_time

Type: string

Время последнего изменения счетчика.

Example: example

vendor_id

Type: integer

visit_threshold

Type: integer

Таймаут визита в секундах.

Default: 1800

Min value: 1800

Max value: 21600

webvisor

Type: WebvisorOptions

Структура с информацией о настройках Вебвизора.

Example
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "wv_forms": true
}
Example
{
  "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_retargeting": true,
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "prev_goal_id": 0,
      "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",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "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,
    "ecommerce_object": "example",
    "ssr": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 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,
  "mirrors_remove": 0,
  "goals_remove": 0,
  "filters_remove": 0,
  "operations_remove": 0,
  "grants_remove": 0,
  "site2": {
    "site": "example",
    "domain": "example",
    "status": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "cms": {
    "code": "example",
    "custom": "example"
  },
  "crm": {
    "code": "example",
    "custom": "example"
  },
  "site_activity": {
    "code": "example",
    "custom": "example"
  },
  "autogoals_enabled": true,
  "counter_flags": {
    "counter_id": 0,
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "incognito": "example",
    "collect_first_party_data": true,
    "collect_masked_first_party_data": true,
    "statistics_over_site": true,
    "measurement_enabled": true,
    "vendor_data": true,
    "allow_use_data_to_collect_feedback": true
  },
  "measurement_tokens": [
    "example"
  ]
}

CommunicationChannel

Каналы коммуникации счетчика. Возможные значения поля code:

  • messengers — Мессенджеры.
  • call_track — Call-tracking телефония.
  • direct_call — Прямые звонки. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example

Example
{
  "code": "example",
  "custom": "example"
}

CounterIndustry

Индустрии счетчика. Возможные значения поля code:

  • finance_and_insurance - Финансы и страхование.
  • real_estate- Недвижимость.
  • construction- Строительство и ремонт.
  • house_and_garden- Дом и сад.
  • domestic_services- Бытовые услуги и общепит.
  • electronics- Электроника.
  • healthcare- Медицина.
  • appliances- Бытовая техника.
  • gastronomy- Кулинария и рецепты.
  • auto_and_moto- Авто и мото.
  • engineering_and_technologies- Техника и технологии.
  • it_and_telecom- IT и Телеком.
  • clothes- Одежда и обувь.
  • health_and_beauty- Здоровье и красота.
  • sport- Спорт и активный образ жизни.
  • jobs_and_career- Работа и карьера.
  • education- Образование.
  • family_and_kids- Семья и дети.
  • pets- Домашние животные.
  • travel- Путешествия и туризм.
  • entertainment- Развлечения, отдых, 18+.
  • social_networks- Общение (соцсети, мессенджеры).
  • gifts- Подарки.
  • business_and_consulting- Бизнес и консалтинг.
  • advertisement- Реклама и маркетинг.
  • online_services- Онлайн-сервисы.
  • industry- Промышленность и сельское хозяйство.
  • transportation- Транспорт и перевозки.
  • legal_services- Юридические услуги и консалтинг.
  • government_and_society- Государство и общество.
  • knowledge_sources- Справочные ресурсы.
  • news- Новости и СМИ.
  • culture_and_art- Культура и искусство.
  • religion- Религия.
  • science- Наука.
  • unexplored- Непознанное. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example

Example
{
  "code": "example",
  "custom": "example"
}

UserActivityProfile

Профили активности пользователя на счетчике. Возможные значения:

  • business- Управление бизнесом.
  • traffic- Маркетинг и реклама.
  • conversions- Продажи и конверсии.
  • product_management- Управление продуктом.
  • marketing- Контент-маркетинг.
  • design- Дизайн интерфейса.
  • development- Разработка и поддержка.
  • analytics- Аналитика. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example

Example
{
  "code": "example",
  "custom": "example"
}

Responses

200 OK

OK

Body

application/json
{
  "counter": {
    "id": 0,
    "status": "example",
    "owner_login": "example",
    "activity_status": "example",
    "name": "example",
    "type": "example",
    "favorite": true,
    "hide_address": true,
    "pro": true,
    "pro_features": [
      "example"
    ],
    "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",
        "user_uid": 0,
        "perm": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "comment": "example",
        "email": "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,
      "allow_wv2": true,
      "notify_wv2": true,
      "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,
      "ecommerce_object": "example",
      "ytm": true,
      "ssr": true
    },
    "create_time": "2025-01-01T00:00:00Z",
    "time_zone_name": "example",
    "time_zone_offset": 0,
    "partner_id": 0,
    "title": "example",
    "grants_cnt": 0,
    "source": "example",
    "update_time": "example",
    "delete_time": "example",
    "code": "example",
    "filter_robots": 1,
    "currency": 0,
    "currency_code": "example",
    "visit_threshold": 1800,
    "max_goals": 0,
    "max_operations": 0,
    "max_filters": 0,
    "features": [
      "example"
    ],
    "publisher_options": {
      "enabled": true,
      "schema": "example",
      "schema_options": [
        "example"
      ]
    },
    "total_geo_points_count": 0,
    "selected_geo_points_count": 0,
    "vendor_id": 0,
    "site2": {
      "site": "example",
      "domain": "example",
      "status": "example"
    },
    "gdpr_agreement_accepted": true,
    "delete_guest_allowed": true,
    "mirrors2": [
      null
    ],
    "cms": {
      "code": "example",
      "custom": "example"
    },
    "crm": {
      "code": "example",
      "custom": "example"
    },
    "communication_channel": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "industry": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "site_activity": {
      "code": "example",
      "custom": "example"
    },
    "user_activity": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "autogoals_enabled": true,
    "ecommerce_deduplicator_enabled": true,
    "counter_flags": {
      "counter_id": 0,
      "use_in_benchmarks": true,
      "direct_allow_use_goals_without_access": true,
      "incognito": "example",
      "collect_first_party_data": true,
      "collect_masked_first_party_data": true,
      "statistics_over_site": true,
      "measurement_enabled": true,
      "vendor_data": true,
      "allow_use_data_to_collect_feedback": true
    },
    "measurement_tokens": [
      "example"
    ]
  }
}

Name

Description

counter

Type: CounterFull

Счетчик.

Example
{
  "id": 0,
  "status": "example",
  "owner_login": "example",
  "activity_status": "example",
  "name": "example",
  "type": "example",
  "favorite": true,
  "hide_address": true,
  "pro": true,
  "pro_features": [
    "example"
  ],
  "permission": "example",
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "prev_goal_id": 0,
      "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",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "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,
    "allow_wv2": true,
    "notify_wv2": true,
    "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,
    "ecommerce_object": "example",
    "ytm": true,
    "ssr": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 0,
  "partner_id": 0,
  "title": "example",
  "grants_cnt": 0,
  "source": "example",
  "update_time": "example",
  "delete_time": "example",
  "code": "example",
  "filter_robots": 1,
  "currency": 0,
  "currency_code": "example",
  "visit_threshold": 1800,
  "max_goals": 0,
  "max_operations": 0,
  "max_filters": 0,
  "features": [
    "example"
  ],
  "publisher_options": {
    "enabled": true,
    "schema": "example",
    "schema_options": [
      "example"
    ]
  },
  "total_geo_points_count": 0,
  "selected_geo_points_count": 0,
  "vendor_id": 0,
  "site2": {
    "site": "example",
    "domain": "example",
    "status": "example"
  },
  "gdpr_agreement_accepted": true,
  "delete_guest_allowed": true,
  "mirrors2": [
    null
  ],
  "cms": {
    "code": "example",
    "custom": "example"
  },
  "crm": {
    "code": "example",
    "custom": "example"
  },
  "communication_channel": [
    {
      "code": "example",
      "custom": "example"
    }
  ],
  "industry": [
    {
      "code": "example",
      "custom": "example"
    }
  ],
  "site_activity": {
    "code": "example",
    "custom": "example"
  },
  "user_activity": [
    {
      "code": "example",
      "custom": "example"
    }
  ],
  "autogoals_enabled": true,
  "ecommerce_deduplicator_enabled": true,
  "counter_flags": {
    "counter_id": 0,
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "incognito": "example",
    "collect_first_party_data": true,
    "collect_masked_first_party_data": true,
    "statistics_over_site": true,
    "measurement_enabled": true,
    "vendor_data": true,
    "allow_use_data_to_collect_feedback": true
  },
  "measurement_tokens": [
    "example"
  ]
}

GoalE

Name

Description

name

Type: string

Наименование цели.

Min length: 0

Max length: 255

Example: example

type

Type: string

Тип цели:

  • action — JavaScript-событие.
  • chat — клик по чату.
  • email — клик по email.
  • file — скачивание файлов.
  • messenger — переход в мессенджер.
  • number — количество просмотров.
  • payment_system — платежная система.
  • phone — клик по номеру телефона.
  • search — поиск по сайту.
  • social — переход в соцсети.
  • step — составная цель.
  • url — посещение страниц.
  • visit_duration — продолжительность визита.

Example: example

default_price

Type: number

Цена цели по умолчанию.

goal_source

Type: string

Признак того, как создана цель:

Example: example

id

Type: integer

Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.

is_favorite

Type: boolean

Является ли цель избранной:

  • 0 ― не является (по умолчанию).
  • 1 ― является.

status

Type: string

Example: example

Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}

ActionGoal

JavaScript-событие.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

ChatGoal

Нажатие на чат.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: array
    One of 3 types
    Example
    [
      {
        "field": "example",
        "answered": true
      }
    ]
    
    Example
    {
      "conditions": [
        {
          "field": "example",
          "answered": true
        }
      ]
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    null
  ]
}

ConditionalGoal

Список шагов составной цели.

Name

Description

name

Type: string

Наименование цели.

Min length: 0

Max length: 255

Example: example

type

Type: string

Тип цели:

  • action — JavaScript-событие.
  • chat — клик по чату.
  • email — клик по email.
  • file — скачивание файлов.
  • messenger — переход в мессенджер.
  • number — количество просмотров.
  • payment_system — платежная система.
  • phone — клик по номеру телефона.
  • search — поиск по сайту.
  • social — переход в соцсети.
  • step — составная цель.
  • url — посещение страниц.
  • visit_duration — продолжительность визита.

Example: example

conditions

Type: GoalCondition[]

Example
[
  {
    "type": "example",
    "url": "example"
  }
]

default_price

Type: number

Цена цели по умолчанию.

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basketкорзина, страница посещения корзины.
  • orderзаказ, страница подтверждения заказа.

Example: example

goal_source

Type: string

Признак того, как создана цель:

Example: example

id

Type: integer

Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.

is_favorite

Type: boolean

Является ли цель избранной:

  • 0 ― не является (по умолчанию).
  • 1 ― является.

status

Type: string

Example: example

Example
{
  "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"
}

CompositeGoal

Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    steps

    Type: ConditionalGoal[]

    Min items: 0

    Max items: 5

    Example
    [
      {
        "id": 0,
        "name": "example",
        "type": "example",
        "default_price": 0.5,
        "is_retargeting": true,
        "goal_source": "example",
        "is_favorite": true,
        "status": "example",
        "conditions": [
          {
            "type": "example",
            "url": "example"
          }
        ],
        "prev_goal_id": 0,
        "flag": "example"
      }
    ]
    
    Example
    {
      "steps": [
        {
          "id": 0,
          "name": "example",
          "type": "example",
          "default_price": 0.5,
          "is_retargeting": true,
          "goal_source": "example",
          "is_favorite": true,
          "status": "example",
          "conditions": [
            {
              "type": "example",
              "url": "example"
            }
          ],
          "prev_goal_id": 0,
          "flag": "example"
        }
      ]
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "steps": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {}
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
  ]
}

DepthGoal

Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    depth

    Type: integer

    Количество просмотренных пользователем страниц.

    Min value: 2

    Example
    {
      "depth": 2
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "depth": 2
}

EmailGoal

Нажатие на email.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

FileGoal

Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

MessengerGoal

Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

PaymentSystemGoal

Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.

All of 1 type
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}

PhoneGoal

Нажатие на номер телефона.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    hide_phone_number

    Type: boolean

    Скрывать номер телефона на десктопах.

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example",
      "hide_phone_number": true
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example",
  "hide_phone_number": true
}

SiteSearchGoal

Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

SocialNetworkGoal

Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

UrlGoal

Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
      {
        "type": "example",
        "url": "example"
      }
    ]
    

    flag

    Type: string

    Тип цели для клиентов Яндекс Маркета:

    • basketкорзина, страница посещения корзины.
    • orderзаказ, страница подтверждения заказа.

    Example: example

    Example
    {
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "flag": "example"
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

VisitDurationGoal

Продолжительность визита. Цель будет достигнута при времени визита больше заданного.

All of 2 types
  • Type: GoalE

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: object

    duration

    Type: integer

    Продолжительность визита в секундах.

    Min value: 1

    Example
    {
      "duration": 1
    }
    
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "duration": 1
}

CodeOptionsE

Настройки кода счетчика.

Name

Description

alternative_cdn

Type: boolean

Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

async

Type: boolean

Асинхронный код счетчика:

  • 0 ― отключено.
  • 1 ― включено (по умолчанию).

clickmap

Type: boolean

Сбор статистики для работы отчета Карта кликов:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

ecommerce

Type: boolean

Сбор данных по электронной коммерции:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

in_one_line

Type: boolean

Выводить код счетчика в одну строку:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

informer

Type: InformerOptionsE

Настройки информера.

Example
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}

track_hash

Type: boolean

Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

visor

Type: boolean

Запись и анализ поведения посетителей сайта:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

xml_site

Type: boolean

Для XML-сайтов. Элемент noscript не должен использоваться в XML документах:

  • 0 ― отключено (по умолчанию).
  • 1 ― включено.

ytm

Type: boolean

Использование системы управления тегами. Возможные значения:

  • 0 ― не используется.
  • 1 — используется.

Example
{
  "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
}

CounterEdit

Счетчик.

Name

Description

activity_status

Type: string

Посещаемость счетчика. Возможные значения:

  • low — низкая посещаемость.
  • high — высокая посещаемость.

Example: example

autogoals_enabled

Type: boolean

Включение автоматических целей. Возможные значения:

  • true — опция включена.
  • false — опция выключена.

cms

Type: CounterCms

CMS система счетчика. Возможные значения поля code:

  • bitrix24 — Битрикс24.
  • flexbe — Flexbe.
  • joomla — Joomla.
  • drupal — Drupal.
  • opencart — OpenCart.
  • tilda — Tilda.
  • webasyst — Webasyst.
  • wix — Wix.
  • wordpress — Wordpress.
  • insales — Insales.
  • nethouse — Nethouse. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
Example
{
  "code": "example",
  "custom": "example"
}

code

Type: string

HTML-код вставки.

Example: example

code_options

Type: CodeOptionsE

Настройки кода счетчика.

Example
{
  "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,
  "ecommerce_object": "example",
  "ytm": true,
  "ssr": true
}

counter_flags

Type: CounterFlags

Безопасность и использование данных.

Example
{
  "counter_id": 0,
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "incognito": "example",
  "collect_first_party_data": true,
  "collect_masked_first_party_data": true,
  "statistics_over_site": true,
  "measurement_enabled": true,
  "vendor_data": true,
  "allow_use_data_to_collect_feedback": true
}

create_time

Type: string<date-time>

Дата и время создания счетчика.

Example: 2025-01-01T00:00:00Z

crm

Type: CounterCrm

CRM система счетчика. Возможные значения поля code:

  • amocrm — AmoCRM.
  • bitrix24 — Битрикс24.
  • megaplan — Мегаплан.
  • crm_1c — 1С:CRM.
  • moysklad — Мой склад.
  • yclients — Yclients.
  • retailcrm — RetailCRM. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
Example
{
  "code": "example",
  "custom": "example"
}

delete_time

Type: string

Время удаления счетчика.

Example: example

favorite

Type: boolean

Добавлен ли счетчик в избранное:

  • 0 ― не добавлен (по умолчанию);
  • 1 ― добавлен.

filter_robots

Type: integer

Фильтрация роботов:

  • 1 — фильтровать роботов только по строгим правилам (по умолчанию);
  • 2 — фильтровать роботов по строгим правилам и по поведению.

Min value: 1

Max value: 2

filters

Type: FilterE[]

Example
[
  {
    "id": 0,
    "attr": "example",
    "type": "example",
    "value": "example",
    "action": "example",
    "status": "example",
    "start_ip": "example",
    "end_ip": "example",
    "with_subdomains": true
  }
]

filters_remove

Type: integer

Нужно ли удалить фильтры:

  • 0 — не удалять фильтры (по умолчанию);
  • 1 — игнорировать входящий параметр filters (если указан), а также удалить ранее заданные фильтры счетчика.

gdpr_agreement_accepted

Type: boolean

Согласие с Договором об обработке данных в сервисе Яндекс Метрика.

  • 0 — договор не принят (по умолчанию).
  • 1 — договор принят.

goals

Type: array
One of 13 types
  • Type: ActionGoal

    JavaScript-событие.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: ChatGoal

    Нажатие на чат.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ]
    }
    
  • Type: CompositeGoal

    Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "steps": [
        {
          "id": 0,
          "name": "example",
          "type": "example",
          "default_price": 0.5,
          "is_retargeting": true,
          "goal_source": "example",
          "is_favorite": true,
          "status": "example",
          "conditions": [
            {}
          ],
          "prev_goal_id": 0,
          "flag": "example"
        }
      ]
    }
    
  • Type: DepthGoal

    Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "depth": 2
    }
    
  • Type: EmailGoal

    Нажатие на email.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: FileGoal

    Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: MessengerGoal

    Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: PaymentSystemGoal

    Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: PhoneGoal

    Нажатие на номер телефона.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example",
      "hide_phone_number": true
    }
    
  • Type: SiteSearchGoal

    Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: SocialNetworkGoal

    Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: UrlGoal

    Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example",
      "price_locations": [
        {
          "type_of_path": "example",
          "path": "example"
        }
      ]
    }
    
  • Type: VisitDurationGoal

    Продолжительность визита. Цель будет достигнута при времени визита больше заданного.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "duration": 1
    }
    

Список структур с информацией о целях счетчика.

Example
[
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_retargeting": true,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {}
    ],
    "prev_goal_id": 0,
    "flag": "example"
  }
]

goals_remove

Type: integer

Нужно ли удалить цели:

  • 0 — не удалять цели (по умолчанию);
  • 1 — игнорировать входящий параметр goals (если указан), а также удалить для счетчика ранее заданные цели.

grants

Type: array
One of 2 types
  • Type: CounterGrantE

    Список структур с информацией о правах доступа к счетчику.

    Example
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true
    }
    
  • Type: AccessFiltersGrantE

    Example
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true,
      "access_filters": [
        {
          "id": 0,
          "name": "example"
        }
      ]
    }
    
Example
[
  {
    "user_login": "example",
    "user_uid": 0,
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "email": "example",
    "partner_data_access": true
  }
]

grants_remove

Type: integer

Нужно ли удалить настройки доступа:

  • 0 — не удалять настройки доступа (по умолчанию);
  • 1 — игнорировать входящий параметр grants (если указан), а также удалить для счетчика ранее заданные настройки доступа.

id

Type: integer

Идентификатор счетчика.

labels

Type: Label[]

Список структур с информацией о метках.

Example
[
  {
    "id": 0,
    "name": "example"
  }
]

measurement_tokens

Type: string[]

Example
[
  "example"
]

mirrors_remove

Type: integer

Нужно ли удалить зеркала:

  • 0 — не удалять зеркала (по умолчанию);
  • 1 — игнорировать входящий параметр mirrors (если указан), а также удалить для счетчика ранее заданные зеркала сайта.

mirrors2

Type: CounterMirrorE[]

Example
[
  {
    "site": "example",
    "domain": "example",
    "status": "example"
  }
]

name

Type: string

Наименование счетчика.

Min length: 0

Max length: 255

Example: example

operations

Type: OperationE[]

Example
[
  {
    "id": 0,
    "action": "example",
    "attr": "example",
    "value": "example",
    "status": "example"
  }
]

operations_remove

Type: integer

Нужно ли удалить операции:

  • 0 — не удалять операции (по умолчанию);
  • 1 — игнорировать входящий параметр operations (если указан), а также удалить ранее заданные операции счетчика.

owner_login

Type: string

Логин владельца счетчика.

Example: example

permission

Type: string

Уровень доступа к счетчику:

  • own — счетчик, принадлежащий пользователю.
  • view — гостевой счетчик с уровнем доступа только просмотр.
  • edit — гостевой счетчик с уровнем доступа полный доступ.
  • analyst — гостевой счетчик с уровнем доступа аналитика.
  • view_access_filter — гостевой счетчик с уровнем доступа только просмотр через фильтр доступа.
  • analyst_access_filter — гостевой счетчик с уровнем доступа аналитика данных через фильтр доступа.

Example: example

publisher_options

Type: PublisherOptions

Структура с информацией о настройках контентной аналитики.

Example
{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "example"
  ]
}

site_activity

Type: SiteActivityProfile

Профиль активности счетчика. Возможные значения поля code:

  • retail- Интернет-магазин.
  • promo_site- Промо-сайт.
  • online_service- Облачное приложение.
  • text_site- Информационный сайт. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.
Example
{
  "code": "example",
  "custom": "example"
}

site2

Type: CounterMirrorE

Список зеркал (доменов) сайта.

Example
{
  "site": "example",
  "domain": "example",
  "status": "example"
}

source

Type: string

Тип счетчика. Возможные значения:

  • turbodirect — Турбо Директ.
  • marketplace_direct — Маркетплейсы Директ.
  • sprav — Бизнес.
  • partner — РСЯ.
  • system — Системный.
  • market — Маркет.
  • eda — Еда.
  • dzen — Дзен.
  • geoadv — Кабинет рекламодателя.
  • games — Игры.

Example: example

status

Type: string

Статус счетчика. возможные значения:

  • Active — счетчик активен.
  • Deleted — счетчик удален.

Example: example

time_zone_name

Type: string

Часовой пояс для расчета статистики.

Example: example

time_zone_offset

Type: integer

Текущее смещение часового пояса от Гринвича, минуты.

type

Type: string

Тип счетчика. Возможные значения:

  • simple — счетчик создан пользователем в Яндекс Метрике.
  • partner — счетчик импортирован из РСЯ.

Example: example

update_time

Type: string

Время последнего изменения счетчика.

Example: example

vendor_id

Type: integer

visit_threshold

Type: integer

Таймаут визита в секундах.

Default: 1800

Min value: 1800

Max value: 21600

webvisor

Type: WebvisorOptions

Структура с информацией о настройках Вебвизора.

Example
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "allow_wv2": true,
  "notify_wv2": true,
  "wv_forms": true
}
Example
{
  "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_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "prev_goal_id": 0,
      "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",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "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,
    "allow_wv2": true,
    "notify_wv2": true,
    "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,
    "ecommerce_object": "example",
    "ytm": true,
    "ssr": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 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,
  "mirrors_remove": 0,
  "goals_remove": 0,
  "filters_remove": 0,
  "operations_remove": 0,
  "grants_remove": 0,
  "site2": {
    "site": "example",
    "domain": "example",
    "status": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "cms": {
    "code": "example",
    "custom": "example"
  },
  "crm": {
    "code": "example",
    "custom": "example"
  },
  "site_activity": {
    "code": "example",
    "custom": "example"
  },
  "autogoals_enabled": true,
  "counter_flags": {
    "counter_id": 0,
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "incognito": "example",
    "collect_first_party_data": true,
    "collect_masked_first_party_data": true,
    "statistics_over_site": true,
    "measurement_enabled": true,
    "vendor_data": true,
    "allow_use_data_to_collect_feedback": true
  },
  "measurement_tokens": [
    "example"
  ]
}

CounterFull

Счетчик.

Name

Description

activity_status

Type: string

Посещаемость счетчика. Возможные значения:

  • low — низкая посещаемость.
  • high — высокая посещаемость.

Example: example

autogoals_enabled

Type: boolean

Включение автоматических целей. Возможные значения:

  • true — опция включена.
  • false — опция выключена.

cms

Type: CounterCms

CMS система счетчика. Возможные значения поля code:

  • bitrix24 — Битрикс24.
  • flexbe — Flexbe.
  • joomla — Joomla.
  • drupal — Drupal.
  • opencart — OpenCart.
  • tilda — Tilda.
  • webasyst — Webasyst.
  • wix — Wix.
  • wordpress — Wordpress.
  • insales — Insales.
  • nethouse — Nethouse. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
Example
{
  "code": "example",
  "custom": "example"
}

code

Type: string

HTML-код вставки.

Example: example

code_options

Type: CodeOptionsE

Настройки кода счетчика.

Example
{
  "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,
  "ecommerce_object": "example",
  "ytm": true,
  "ssr": true
}

counter_flags

Type: CounterFlags

Безопасность и использование данных.

Example
{
  "counter_id": 0,
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "incognito": "example",
  "collect_first_party_data": true,
  "collect_masked_first_party_data": true,
  "statistics_over_site": true,
  "measurement_enabled": true,
  "vendor_data": true,
  "allow_use_data_to_collect_feedback": true
}

create_time

Type: string<date-time>

Дата и время создания счетчика.

Example: 2025-01-01T00:00:00Z

crm

Type: CounterCrm

CRM система счетчика. Возможные значения поля code:

  • amocrm — AmoCRM.
  • bitrix24 — Битрикс24.
  • megaplan — Мегаплан.
  • crm_1c — 1С:CRM.
  • moysklad — Мой склад.
  • yclients — Yclients.
  • retailcrm — RetailCRM. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
Example
{
  "code": "example",
  "custom": "example"
}

delete_time

Type: string

Время удаления счетчика.

Example: example

favorite

Type: boolean

Добавлен ли счетчик в избранное:

  • 0 ― не добавлен (по умолчанию);
  • 1 ― добавлен.

filter_robots

Type: integer

Фильтрация роботов:

  • 1 — фильтровать роботов только по строгим правилам (по умолчанию);
  • 2 — фильтровать роботов по строгим правилам и по поведению.

Min value: 1

Max value: 2

filters

Type: FilterE[]

Example
[
  {
    "id": 0,
    "attr": "example",
    "type": "example",
    "value": "example",
    "action": "example",
    "status": "example",
    "start_ip": "example",
    "end_ip": "example",
    "with_subdomains": true
  }
]

gdpr_agreement_accepted

Type: boolean

Согласие с Договором об обработке данных в сервисе Яндекс Метрика.

  • 0 — договор не принят (по умолчанию).
  • 1 — договор принят.

goals

Type: array
One of 13 types
  • Type: ActionGoal

    JavaScript-событие.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: ChatGoal

    Нажатие на чат.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ]
    }
    
  • Type: CompositeGoal

    Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "steps": [
        {
          "id": 0,
          "name": "example",
          "type": "example",
          "default_price": 0.5,
          "is_retargeting": true,
          "goal_source": "example",
          "is_favorite": true,
          "status": "example",
          "conditions": [
            {}
          ],
          "prev_goal_id": 0,
          "flag": "example"
        }
      ]
    }
    
  • Type: DepthGoal

    Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "depth": 2
    }
    
  • Type: EmailGoal

    Нажатие на email.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: FileGoal

    Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: MessengerGoal

    Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: PaymentSystemGoal

    Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example"
    }
    
  • Type: PhoneGoal

    Нажатие на номер телефона.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example",
      "hide_phone_number": true
    }
    
  • Type: SiteSearchGoal

    Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: SocialNetworkGoal

    Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
    
  • Type: UrlGoal

    Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example",
      "price_locations": [
        {
          "type_of_path": "example",
          "path": "example"
        }
      ]
    }
    
  • Type: VisitDurationGoal

    Продолжительность визита. Цель будет достигнута при времени визита больше заданного.

    Example
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "duration": 1
    }
    

Список структур с информацией о целях счетчика.

Example
[
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_retargeting": true,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {}
    ],
    "prev_goal_id": 0,
    "flag": "example"
  }
]

grants

Type: array
One of 2 types
  • Type: CounterGrantE

    Список структур с информацией о правах доступа к счетчику.

    Example
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true
    }
    
  • Type: AccessFiltersGrantE

    Example
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true,
      "access_filters": [
        {
          "id": 0,
          "name": "example"
        }
      ]
    }
    
Example
[
  {
    "user_login": "example",
    "user_uid": 0,
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "email": "example",
    "partner_data_access": true
  }
]

id

Type: integer

Идентификатор счетчика.

labels

Type: Label[]

Список структур с информацией о метках.

Example
[
  {
    "id": 0,
    "name": "example"
  }
]

measurement_tokens

Type: string[]

Example
[
  "example"
]

mirrors2

Type: CounterMirrorE[]

Example
[
  {
    "site": "example",
    "domain": "example",
    "status": "example"
  }
]

name

Type: string

Наименование счетчика.

Min length: 0

Max length: 255

Example: example

operations

Type: OperationE[]

Example
[
  {
    "id": 0,
    "action": "example",
    "attr": "example",
    "value": "example",
    "status": "example"
  }
]

owner_login

Type: string

Логин владельца счетчика.

Example: example

permission

Type: string

Уровень доступа к счетчику:

  • own — счетчик, принадлежащий пользователю.
  • view — гостевой счетчик с уровнем доступа только просмотр.
  • edit — гостевой счетчик с уровнем доступа полный доступ.
  • analyst — гостевой счетчик с уровнем доступа аналитика.
  • view_access_filter — гостевой счетчик с уровнем доступа только просмотр через фильтр доступа.
  • analyst_access_filter — гостевой счетчик с уровнем доступа аналитика данных через фильтр доступа.

Example: example

publisher_options

Type: PublisherOptions

Структура с информацией о настройках контентной аналитики.

Example
{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "example"
  ]
}

site_activity

Type: SiteActivityProfile

Профиль активности счетчика. Возможные значения поля code:

  • retail- Интернет-магазин.
  • promo_site- Промо-сайт.
  • online_service- Облачное приложение.
  • text_site- Информационный сайт. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.
Example
{
  "code": "example",
  "custom": "example"
}

site2

Type: CounterMirrorE

Список зеркал (доменов) сайта.

Example
{
  "site": "example",
  "domain": "example",
  "status": "example"
}

source

Type: string

Тип счетчика. Возможные значения:

  • turbodirect — Турбо Директ.
  • marketplace_direct — Маркетплейсы Директ.
  • sprav — Бизнес.
  • partner — РСЯ.
  • system — Системный.
  • market — Маркет.
  • eda — Еда.
  • dzen — Дзен.
  • geoadv — Кабинет рекламодателя.
  • games — Игры.

Example: example

status

Type: string

Статус счетчика. возможные значения:

  • Active — счетчик активен.
  • Deleted — счетчик удален.

Example: example

time_zone_name

Type: string

Часовой пояс для расчета статистики.

Example: example

time_zone_offset

Type: integer

Текущее смещение часового пояса от Гринвича, минуты.

type

Type: string

Тип счетчика. Возможные значения:

  • simple — счетчик создан пользователем в Яндекс Метрике.
  • partner — счетчик импортирован из РСЯ.

Example: example

update_time

Type: string

Время последнего изменения счетчика.

Example: example

vendor_id

Type: integer

visit_threshold

Type: integer

Таймаут визита в секундах.

Default: 1800

Min value: 1800

Max value: 21600

webvisor

Type: WebvisorOptions

Структура с информацией о настройках Вебвизора.

Example
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "allow_wv2": true,
  "notify_wv2": true,
  "wv_forms": true
}
Example
{
  "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_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "prev_goal_id": 0,
      "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",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "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,
    "allow_wv2": true,
    "notify_wv2": true,
    "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,
    "ecommerce_object": "example",
    "ytm": true,
    "ssr": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 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",
    "domain": "example",
    "status": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "cms": {
    "code": "example",
    "custom": "example"
  },
  "crm": {
    "code": "example",
    "custom": "example"
  },
  "site_activity": {
    "code": "example",
    "custom": "example"
  },
  "autogoals_enabled": true,
  "counter_flags": {
    "counter_id": 0,
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "incognito": "example",
    "collect_first_party_data": true,
    "collect_masked_first_party_data": true,
    "statistics_over_site": true,
    "measurement_enabled": true,
    "vendor_data": true,
    "allow_use_data_to_collect_feedback": true
  },
  "measurement_tokens": [
    "example"
  ]
}

No longer supported, please use an alternative and newer version.