Информация о счетчике

Возвращает информацию об указанном счетчике.

  1. Синтаксис запроса
  2. Формат ответа

Синтаксис запроса

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

https://api-metrika.yandex.net/management/v1/counter/{counterId}
 ? [callback=<string>]
 & [field=<string>]
callbackФункция обратного вызова, которая обрабатывает ответ API.
fieldОдин или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: field=goals,mirrors,grants,filters,operation.
callbackФункция обратного вызова, которая обрабатывает ответ API.
fieldОдин или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: field=goals,mirrors,grants,filters,operation.

Формат ответа


{
    "counter" : {
        "id" :  < int > ,
        "status" :  < counter_status > ,
        "owner_login" :  < string > ,
        "code_status" :  < string > ,
        "activity_status" :  < counter_activity_status > ,
        "name" :  < string > ,
        "site2" : {
            "site" :  < string > 
        },
        "type" :  < counter_type > ,
        "favorite" :  < boolean > ,
        "gdpr_agreement_accepted" :  < boolean > ,
        "permission" :  < counter_permission > ,
        "mirrors2" : [ {
            "site" :  < string > 
        }, ... ],
        "goals" : [  < goal > , ... ],
        "filters" : [ {
            "id" :  < int > ,
            "attr" :  < filter_attribute > ,
            "type" :  < filter_type > ,
            "value" :  < string > ,
            "action" :  < filter_action > ,
            "status" :  < filter_status > ,
            "start_ip" :  < string > ,
            "end_ip" :  < string > ,
            "with_subdomains" :  < boolean > 
        }, ... ],
        "operations" : [ {
            "id" :  < int > ,
            "action" :  < operation_type > ,
            "attr" :  < operation_attribute > ,
            "value" :  < string > ,
            "status" :  < operation_status > 
        }, ... ],
        "grants" : [ {
            "user_login" :  < string > ,
            "user_uid" :  < long > ,
            "perm" :  < grant_type > ,
            "created_at" :  < date > ,
            "comment" :  < string > ,
            "partner_data_access" :  < boolean > 
        }, ... ],
        "labels" : [ {
            "id" :  < int > ,
            "name" :  < string > 
        }, ... ],
        "webvisor" : {
            "urls" :  < string > ,
            "arch_enabled" :  < boolean > ,
            "arch_type" :  < webvisor_arch_type > ,
            "load_player_type" :  < webvisor_load_player_type > ,
            "wv_version" :  < integer > ,
            "wv_forms" :  < boolean > 
        },
        "code_options" : {
            "async" :  < boolean > ,
            "informer" : {
                "enabled" :  < boolean > ,
                "type" :  < informer_type > ,
                "size" :  < integer > ,
                "indicator" :  < informer_metric > ,
                "color_start" :  < string > ,
                "color_end" :  < string > ,
                "color_text" :  < integer > ,
                "color_arrow" :  < integer > 
            },
            "visor" :  < boolean > ,
            "track_hash" :  < boolean > ,
            "xml_site" :  < boolean > ,
            "clickmap" :  < boolean > ,
            "in_one_line" :  < boolean > ,
            "ecommerce" :  < boolean > ,
            "alternative_cdn" :  < boolean > 
        },
        "create_time" :  < date > ,
        "time_zone_name" :  < string > ,
        "time_zone_offset" :  < int > ,
        "source" :  < counter_source > ,
        "update_time" :  < string > ,
        "delete_time" :  < string > ,
        "code" :  < string > ,
        "monitoring" : {
            "enable_monitoring" :  < int > ,
            "emails" : [  < string > , ... ],
            "sms_allowed" :  < int > ,
            "enable_sms" :  < int > ,
            "sms_time" :  < string > ,
            "phones" : [  < string > , ... ],
            "phone_ids" : [  < long > , ... ],
            "possible_phones" : [  < string > , ... ],
            "possible_phone_ids" : [  < string > , ... ]
        },
        "filter_robots" :  < integer > ,
        "visit_threshold" :  < integer > ,
        "offline_options" : {
            "offline_conversion_extended_threshold" :  < boolean > ,
            "offline_calls_extended_threshold" :  < boolean > ,
            "offline_visits_extended_threshold" :  < boolean > 
        },
        "publisher_options" : {
            "enabled" :  < boolean > ,
            "schema" :  < publisher_schema > ,
            "schema_options" : [  < publisher_schema > , ... ]
        },
        "autogoals_enabled" :  < boolean > ,
        "counter_flags" : {
            "use_in_benchmarks" :  < boolean > ,
            "direct_allow_use_goals_without_access" :  < boolean > ,
            "collect_first_party_data" :  < boolean > 
        }
    }
}
Параметры Описание
counter Счетчик.
counter
id Идентификатор счетчика.
status Статус счетчика.

Возможные значения:

  • Active — Счетчик активен
  • Deleted — Счетчик удален
owner_login Логин владельца счетчика.
code_status Статус установки кода счетчика.
Внимание. Параметр устарел — не используйте его при работе с данными. В качестве значения всегда возвращается CS_ERR_UNKNOWN (неизвестная ошибка). В будущем code_status будет удален.
activity_status Посещаемость счетчика.
name Наименование счетчика.
site2 Полный домен сайта.
type Тип счетчика.

Возможные значения:

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

Возможные значения:

  • 0 ― не добавлен (по умолчанию);
  • 1 ― добавлен.
gdpr_agreement_accepted Согласие с Договором об обработке данных в сервисе «Яндекс.Метрика».

Возможные значения:

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

Возможные значения:

  • own — счетчик, принадлежащий пользователю;
  • view — гостевой счетчик с уровнем доступа «только просмотр»;
  • edit — гостевой счетчик с уровнем доступа «полный доступ».
mirrors2 Список зеркал (доменов) сайта.
goals Список структур с информацией о целях счетчика.
filters Список структур с информацией о фильтрах счетчика.
operations Список структур с информацией об операциях счетчика.
grants Список структур с информацией о правах доступа к счетчику.
labels Список структур с информацией о метках.
webvisor Структура с информацией о настройках Вебвизора.
code_options Настройки кода счетчика.
create_time Дата и время создания счетчика.
time_zone_name Часовой пояс для расчета статистики.
time_zone_offset Текущее смещение часового пояса от Гринвича, минуты.
source Тип счетчика
update_time Время последнего изменения счетчика.
delete_time Время удаления счетчика.
code

HTML-код счетчика

monitoring

Настройки мониторинга доступности сайта.

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

Возможные значения:

  • 1 — фильтровать роботов только по строгим правилам (по умолчанию);
  • 2 — фильтровать роботов по строгим правилам и по поведению.
visit_threshold Тайм-аут визита в секундах.
offline_options Настройки офлайн-событий.
publisher_options Структура с информацией о настройках контентной аналитики.
autogoals_enabled Включение автоматических целей.

Возможные значения:

  • true — опция включена;
  • false — опция отключена.
counter_flags Безопасность и использование данных.
site2
site Полный домен сайта.
mirrors2
site Полный домен сайта.
filters
id

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

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

Возможные значения:

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

Возможные значения:

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

Возможные значения:

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

Возможные значения:

  • active — фильтр используется;
  • disabled — фильтр отключен (без удаления).
start_ip Первый IP-адрес диапазона.
end_ip Последний IP-адрес диапазона.
with_subdomains Фильтровать по поддоменам.
operations
id

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

action Тип операции.

Возможные значения:

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

Возможные значения:

  • referer — реферер;
  • url — URL страницы.
value Значение для замены.
status Статус операции.

Возможные значения:

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

Логин пользователя, которому выдано разрешение на управление счетчиком.

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

user_uid

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

Параметр содержит 0, если к статистике счетчика предоставлен публичный доступ (perm = public_stat)

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

Возможные значения:

  • public_stat — публичный доступ к статистике;
  • view — только просмотр;
  • edit — полный доступ.
created_at

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

comment

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

partner_data_access

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

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

Возможные значения:

  • true — доступ разрешен;
  • false — доступ не разрешен.
labels
id Идентификатор метки.
name Имя метки.
webvisor
urls Список страниц для сохранения.
arch_enabled Сохранение страниц сайта.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
arch_type Запись содержимого страниц.

Возможные значения:

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

Возможные значения:

  • proxy — от имени анонимного пользователя;
  • on_your_behalf — от вашего имени.
wv_version Версия вебвизора.
wv_forms Запись содержимого полей и форм.

Возможные значения:

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

Возможные значения:

  • 0 ― отключено;
  • 1 ― включено (по умолчанию).
informer Настройки информера.
visor Запись и анализ поведения посетителей сайта.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
track_hash Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
xml_site Для XML-сайтов. Элемент noscript не должен использоваться в XML документах.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
clickmap Сбор статистики для работы отчета Карта кликов.

Возможные значения:

  • 0 ― отключено;
  • 1 ― включено (по умолчанию).
in_one_line Выводить код счетчика в одну строку.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
ecommerce Сбор данных по электронной коммерции.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
alternative_cdn Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
informer
enabled Разрешение отображения информера.

Возможные значения:

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

Возможные значения:

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

Возможные значения:

  • 1 - размер 80х15;
  • 2 - размер 80х31;
  • 3 - размер 88х31 (по умолчанию). На вид информера этого типа не влияет значение поля indicator.
indicator Показатель, который будет отображаться на информере.

Возможные значения:

  • pageviews — просмотры (по умолчанию);
  • visits — визиты;
  • uniques — посетители.
color_start Начальный (верхний) цвет информера в формате RRGGBBAA. RR, GG, BB ― насыщенность красного, зеленого и синего цвета. Насыщенность каждого цвета задается значениями в диапазоне от 00 до FF. AA ― прозрачность от 00 (прозрачный) до FF (непрозрачный).
color_end Конечный (нижний) цвет информера в формате RRGGBBAA. Параметр предназначен для создания градиента фона. Насыщенность и прозрачность цвета задаются аналогично параметру color_start.
color_text Цвет текста на информере.

Возможные значения:

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

Возможные значения:

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

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

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

Список адресов электронной почты для получения уведомлений мониторинга сайта. Может содержать один или несколько адресов, разделенных запятыми

sms_allowed

SMS-уведомления. Для получения уведомлений необходимо на них подписаться и подтвердить подписку. Номер телефона хранится в персональных данных пользователя для всех сервисов Яндекса.

Возможные значения:

  • 0 — пользователь не указал номер мобильного телефона;
  • 1 — пользователь указал номер телефона и подтвердил подписку.
enable_sms

SMS-уведомления для мониторинга доступности сайта. Возможные значения:

  • 0 — пользователь не подписан на SMS-уведомления (по умолчанию);
  • 1 — включена подписка на SMS-уведомления мониторинга.
sms_time

Разрешенные часовые диапазоны для отправки SMS-уведомлений. Диапазоны указываются по дням недели с понедельника по воскресение. Если диапазон не указан для какого-либо дня, в этот день SMS-уведомления не отправляются.

Дни недели разделяются точкой с запятой, как показано в следующем примере:

8-9;8-9;;20-22;;;

Данное значение разрешает отправку SMS с 8:00 по 9:59 в понедельник и вторник и с 20:00 по 22:59 в четверг.

Каждый указанный час соответствует интервалу времени от начала до окончания этого часа. Так, число 9 означает интервал между 9 часов 00 минут и 9 часов 59 минут включительно.

Диапазоны могут состоять из интервалов «с–по» и отдельных часов, например 7-12,16,18,22-23. Компоненты таких диапазонов разделяются запятой.

phones

Список телефонных номеров для получения уведомлений мониторинга сайта. Может содержать один или несколько номеров через запятую.

Чтобы подписаться на уведомления, получите возможные телефонные номера и их идентификаторы (possible_phones и possible_phones_ids) с помощью запроса /management/v1/counter/{counterId}. Затем передайте эти данные при редактировании счетчика в параметрах phones и phone_ids.

phone_ids

Идентификаторы телефонных номеров для получения уведомлений мониторинга. Порядок идентификаторов соответствует порядку телефонных номеров в параметре phones.

possible_phones

Возможные телефонные номера для получения уведомлений мониторинга сайта. Может содержать один или несколько номеров через запятую.

possible_phone_ids Идентификаторы возможных телефонных номеров для получения уведомлений мониторинга сайта. Порядок идентификаторов соответствует порядку телефонных номеров в параметре possible_phones.
offline_options
offline_conversion_extended_threshold Расширенный период учета офлайн-конверсий.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
offline_calls_extended_threshold Расширенный период учета звонков.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
offline_visits_extended_threshold Расширенный период учета оффлайн-заходов.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
publisher_options
enabled Сбор данных контентной аналитики. Для начала сбора статистики нужно добавить на сайт разметку.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
schema Используемый на сайте тип разметки. При создании или редактировании счетчика передайте в этом поле значение из поля schema_options.
schema_options Доступные варианты разметки сайта.
counter_flags
use_in_benchmarks

Получать доступ к отчетам по рынку.

Опция разрешает Метрике использовать агрегированные обезличенные данные счетчика для построения отчетов по аналитике рынка.

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

Если счетчик создан недавно, опция включена по умолчанию.

Возможные значения:

  • false
  • true
direct_allow_use_goals_without_access

Разрешить в рекламных кампаниях оптимизацию по целям без доступа к счетчику.

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

Возможные значения:

  • false
  • true
collect_first_party_data

Использовать дополнительные настройки отслеживания.

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

Возможные значения:

  • false
  • true
Параметры Описание
counter Счетчик.
counter
id Идентификатор счетчика.
status Статус счетчика.

Возможные значения:

  • Active — Счетчик активен
  • Deleted — Счетчик удален
owner_login Логин владельца счетчика.
code_status Статус установки кода счетчика.
Внимание. Параметр устарел — не используйте его при работе с данными. В качестве значения всегда возвращается CS_ERR_UNKNOWN (неизвестная ошибка). В будущем code_status будет удален.
activity_status Посещаемость счетчика.
name Наименование счетчика.
site2 Полный домен сайта.
type Тип счетчика.

Возможные значения:

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

Возможные значения:

  • 0 ― не добавлен (по умолчанию);
  • 1 ― добавлен.
gdpr_agreement_accepted Согласие с Договором об обработке данных в сервисе «Яндекс.Метрика».

Возможные значения:

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

Возможные значения:

  • own — счетчик, принадлежащий пользователю;
  • view — гостевой счетчик с уровнем доступа «только просмотр»;
  • edit — гостевой счетчик с уровнем доступа «полный доступ».
mirrors2 Список зеркал (доменов) сайта.
goals Список структур с информацией о целях счетчика.
filters Список структур с информацией о фильтрах счетчика.
operations Список структур с информацией об операциях счетчика.
grants Список структур с информацией о правах доступа к счетчику.
labels Список структур с информацией о метках.
webvisor Структура с информацией о настройках Вебвизора.
code_options Настройки кода счетчика.
create_time Дата и время создания счетчика.
time_zone_name Часовой пояс для расчета статистики.
time_zone_offset Текущее смещение часового пояса от Гринвича, минуты.
source Тип счетчика
update_time Время последнего изменения счетчика.
delete_time Время удаления счетчика.
code

HTML-код счетчика

monitoring

Настройки мониторинга доступности сайта.

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

Возможные значения:

  • 1 — фильтровать роботов только по строгим правилам (по умолчанию);
  • 2 — фильтровать роботов по строгим правилам и по поведению.
visit_threshold Тайм-аут визита в секундах.
offline_options Настройки офлайн-событий.
publisher_options Структура с информацией о настройках контентной аналитики.
autogoals_enabled Включение автоматических целей.

Возможные значения:

  • true — опция включена;
  • false — опция отключена.
counter_flags Безопасность и использование данных.
site2
site Полный домен сайта.
mirrors2
site Полный домен сайта.
filters
id

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

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

Возможные значения:

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

Возможные значения:

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

Возможные значения:

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

Возможные значения:

  • active — фильтр используется;
  • disabled — фильтр отключен (без удаления).
start_ip Первый IP-адрес диапазона.
end_ip Последний IP-адрес диапазона.
with_subdomains Фильтровать по поддоменам.
operations
id

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

action Тип операции.

Возможные значения:

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

Возможные значения:

  • referer — реферер;
  • url — URL страницы.
value Значение для замены.
status Статус операции.

Возможные значения:

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

Логин пользователя, которому выдано разрешение на управление счетчиком.

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

user_uid

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

Параметр содержит 0, если к статистике счетчика предоставлен публичный доступ (perm = public_stat)

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

Возможные значения:

  • public_stat — публичный доступ к статистике;
  • view — только просмотр;
  • edit — полный доступ.
created_at

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

comment

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

partner_data_access

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

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

Возможные значения:

  • true — доступ разрешен;
  • false — доступ не разрешен.
labels
id Идентификатор метки.
name Имя метки.
webvisor
urls Список страниц для сохранения.
arch_enabled Сохранение страниц сайта.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
arch_type Запись содержимого страниц.

Возможные значения:

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

Возможные значения:

  • proxy — от имени анонимного пользователя;
  • on_your_behalf — от вашего имени.
wv_version Версия вебвизора.
wv_forms Запись содержимого полей и форм.

Возможные значения:

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

Возможные значения:

  • 0 ― отключено;
  • 1 ― включено (по умолчанию).
informer Настройки информера.
visor Запись и анализ поведения посетителей сайта.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
track_hash Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
xml_site Для XML-сайтов. Элемент noscript не должен использоваться в XML документах.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
clickmap Сбор статистики для работы отчета Карта кликов.

Возможные значения:

  • 0 ― отключено;
  • 1 ― включено (по умолчанию).
in_one_line Выводить код счетчика в одну строку.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
ecommerce Сбор данных по электронной коммерции.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
alternative_cdn Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
informer
enabled Разрешение отображения информера.

Возможные значения:

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

Возможные значения:

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

Возможные значения:

  • 1 - размер 80х15;
  • 2 - размер 80х31;
  • 3 - размер 88х31 (по умолчанию). На вид информера этого типа не влияет значение поля indicator.
indicator Показатель, который будет отображаться на информере.

Возможные значения:

  • pageviews — просмотры (по умолчанию);
  • visits — визиты;
  • uniques — посетители.
color_start Начальный (верхний) цвет информера в формате RRGGBBAA. RR, GG, BB ― насыщенность красного, зеленого и синего цвета. Насыщенность каждого цвета задается значениями в диапазоне от 00 до FF. AA ― прозрачность от 00 (прозрачный) до FF (непрозрачный).
color_end Конечный (нижний) цвет информера в формате RRGGBBAA. Параметр предназначен для создания градиента фона. Насыщенность и прозрачность цвета задаются аналогично параметру color_start.
color_text Цвет текста на информере.

Возможные значения:

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

Возможные значения:

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

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

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

Список адресов электронной почты для получения уведомлений мониторинга сайта. Может содержать один или несколько адресов, разделенных запятыми

sms_allowed

SMS-уведомления. Для получения уведомлений необходимо на них подписаться и подтвердить подписку. Номер телефона хранится в персональных данных пользователя для всех сервисов Яндекса.

Возможные значения:

  • 0 — пользователь не указал номер мобильного телефона;
  • 1 — пользователь указал номер телефона и подтвердил подписку.
enable_sms

SMS-уведомления для мониторинга доступности сайта. Возможные значения:

  • 0 — пользователь не подписан на SMS-уведомления (по умолчанию);
  • 1 — включена подписка на SMS-уведомления мониторинга.
sms_time

Разрешенные часовые диапазоны для отправки SMS-уведомлений. Диапазоны указываются по дням недели с понедельника по воскресение. Если диапазон не указан для какого-либо дня, в этот день SMS-уведомления не отправляются.

Дни недели разделяются точкой с запятой, как показано в следующем примере:

8-9;8-9;;20-22;;;

Данное значение разрешает отправку SMS с 8:00 по 9:59 в понедельник и вторник и с 20:00 по 22:59 в четверг.

Каждый указанный час соответствует интервалу времени от начала до окончания этого часа. Так, число 9 означает интервал между 9 часов 00 минут и 9 часов 59 минут включительно.

Диапазоны могут состоять из интервалов «с–по» и отдельных часов, например 7-12,16,18,22-23. Компоненты таких диапазонов разделяются запятой.

phones

Список телефонных номеров для получения уведомлений мониторинга сайта. Может содержать один или несколько номеров через запятую.

Чтобы подписаться на уведомления, получите возможные телефонные номера и их идентификаторы (possible_phones и possible_phones_ids) с помощью запроса /management/v1/counter/{counterId}. Затем передайте эти данные при редактировании счетчика в параметрах phones и phone_ids.

phone_ids

Идентификаторы телефонных номеров для получения уведомлений мониторинга. Порядок идентификаторов соответствует порядку телефонных номеров в параметре phones.

possible_phones

Возможные телефонные номера для получения уведомлений мониторинга сайта. Может содержать один или несколько номеров через запятую.

possible_phone_ids Идентификаторы возможных телефонных номеров для получения уведомлений мониторинга сайта. Порядок идентификаторов соответствует порядку телефонных номеров в параметре possible_phones.
offline_options
offline_conversion_extended_threshold Расширенный период учета офлайн-конверсий.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
offline_calls_extended_threshold Расширенный период учета звонков.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
offline_visits_extended_threshold Расширенный период учета оффлайн-заходов.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
publisher_options
enabled Сбор данных контентной аналитики. Для начала сбора статистики нужно добавить на сайт разметку.

Возможные значения:

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
schema Используемый на сайте тип разметки. При создании или редактировании счетчика передайте в этом поле значение из поля schema_options.
schema_options Доступные варианты разметки сайта.
counter_flags
use_in_benchmarks

Получать доступ к отчетам по рынку.

Опция разрешает Метрике использовать агрегированные обезличенные данные счетчика для построения отчетов по аналитике рынка.

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

Если счетчик создан недавно, опция включена по умолчанию.

Возможные значения:

  • false
  • true
direct_allow_use_goals_without_access

Разрешить в рекламных кампаниях оптимизацию по целям без доступа к счетчику.

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

Возможные значения:

  • false
  • true
collect_first_party_data

Использовать дополнительные настройки отслеживания.

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

Возможные значения:

  • false
  • true