Документация
Справочник разработчика
API управления
Управление клиентами Директа
API отчетов v1
Группировки
Клики
Параметры посетителей

Создание счетчика

Создает счетчик с заданными параметрами.

Краткое содержание

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

POST https://api-metrika.yandex.ru/management/v1/counters ? [field
[no-highlight[Один или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: field=goals,mirrors,grants,filters,operations.]no-highlight]
=<string>]
fieldОдин или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: field=goals,mirrors,grants,filters,operations.

В теле запроса


{
    "counter
[no-highlight[

Описание

Счетчик.

]no-highlight]
" : { "name
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "site
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "mirrors
[no-highlight[

Описание

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

]no-highlight]
" : [ < string > , ... ], "goals
[no-highlight[

Описание

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

]no-highlight]
" : [ < goal > , ... ], "filters
[no-highlight[

Описание

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

]no-highlight]
" : [ { "attr
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < filter_attribute > , "type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < filter_type > , "value
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "action
[no-highlight[

Описание

Тип фильтра.

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

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

]no-highlight]
" : < filter_action > , "status
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < filter_status > , "with_subdomains
[no-highlight[

Описание

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

]no-highlight]
" : < boolean > }, ... ], "operations
[no-highlight[

Описание

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

]no-highlight]
" : [ { "action
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < operation_type > , "attr
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < operation_attribute > , "value
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "status
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < operation_status > }, ... ], "grants
[no-highlight[

Описание

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

]no-highlight]
" : [ { "user_login
[no-highlight[

Описание

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

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

]no-highlight]
" : < string > , "perm
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < grant_type > , "comment
[no-highlight[

Описание

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

]no-highlight]
" : < string > }, ... ], "labels
[no-highlight[

Описание

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

]no-highlight]
" : [ { "id
[no-highlight[

Описание

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

]no-highlight]
" : < int > , "name
[no-highlight[

Описание

Имя метки.

]no-highlight]
" : < string > }, ... ], "webvisor
[no-highlight[

Описание

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

]no-highlight]
" : { "urls
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "arch_enabled
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "arch_type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < webvisor_arch_type > , "load_player_type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < webvisor_load_player_type > , "wv_version
[no-highlight[

Описание

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

]no-highlight]
" : < int > }, "code_options
[no-highlight[

Описание

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

]no-highlight]
" : { "async
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "informer
[no-highlight[

Описание

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

]no-highlight]
" : { "enabled
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < informer_type > , "size
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > , "indicator
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < informer_metric > , "color_start
[no-highlight[

Описание

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

Значение по умолчанию: “FFFFFFFF.“

]no-highlight]
" : < string > , "color_end
[no-highlight[

Описание

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

Значение по умолчанию: “EFEFEFFF“

]no-highlight]
" : < string > , "color_text
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > , "color_arrow
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > }, "visor
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "ut
[no-highlight[

Описание

Запрет отправки на индексацию страниц сайта.

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

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

]no-highlight]
" : < boolean > , "track_hash
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "xml_site
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "clickmap
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "in_one_line
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "ecommerce
[no-highlight[

Описание

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

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
]no-highlight]
" : < boolean > }, "create_time
[no-highlight[

Описание

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

]no-highlight]
" : < date > , "time_zone_name
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "time_zone_offset
[no-highlight[

Описание

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

]no-highlight]
" : < int > , "monitoring
[no-highlight[

Описание

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

]no-highlight]
" : { "enable_monitoring
[no-highlight[

Описание

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

  • 0 — пользователь не подписан на уведомления (по умолчанию);
  • 1 — включена подписка на уведомления мониторинга.
]no-highlight]
" : < int > , "emails
[no-highlight[

Описание

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

]no-highlight]
" : [ < string > , ... ], "enable_sms
[no-highlight[

Описание

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

  • 0 — пользователь не подписан на SMS-уведомления (по умолчанию);
  • 1 — включена подписка на SMS-уведомления мониторинга.
]no-highlight]
" : < int > , "sms_time
[no-highlight[

Описание

Разрешенные часовые диапазоны для отправки 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. Компоненты таких диапазонов разделяются запятой.

]no-highlight]
" : < string > , "phones
[no-highlight[

Описание

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

]no-highlight]
" : [ < string > , ... ] }, "filter_robots
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > , "visit_threshold
[no-highlight[

Описание

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

Значение по умолчанию: “1800“

]no-highlight]
" : < integer > , "offline_options
[no-highlight[

Описание

Настройки офлайн-событий.

]no-highlight]
" : { "offline_conversion_extended_threshold
[no-highlight[

Описание

Расширенный период учета офлайн-конверсий.

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

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

]no-highlight]
" : < boolean > , "offline_calls_extended_threshold
[no-highlight[

Описание

Расширенный период учета звонков.

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

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

]no-highlight]
" : < boolean > } } }
ПараметрыОписание
counter Счетчик.
counter
name Наименование счетчика.
site Полный домен сайта.
mirrors Список зеркал (доменов) сайта.
goals Список структур с информацией о целях счетчика.
filters Список структур с информацией о фильтрах счетчика.
operations Список структур с информацией об операциях счетчика.
grants Список структур с информацией о правах доступа к счетчику.
labels Список структур с информацией о метках.
webvisor Структура с информацией о настройках Вебвизора.
code_options Настройки кода счетчика.
create_time Дата и время создания счетчика.
time_zone_name Часовой пояс для расчета статистики.
time_zone_offset Текущее смещение часового пояса от Гринвича, минуты
monitoring

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

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

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

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

Значение по умолчанию: "1800"

offline_options Настройки офлайн-событий.
filters
attr Тип данных, к которым применяется фильтр.

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

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

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

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

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

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

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

  • active — фильтр используется;
  • disabled — фильтр отключен (без удаления).
with_subdomains Фильтровать по поддоменам.
operations
action Тип операции.

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

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

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

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

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

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

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

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

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

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

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

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

labels
id Идентификатор метки.
name Имя метки.
webvisor
urls Список страниц для сохранения.
arch_enabled Сохранение страниц сайта.

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

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

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

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

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

  • proxy — от имени анонимного пользователя;
  • on_your_behalf — от вашего имени.
wv_version Версия вебвизора.
code_options
async Асинхронный код счетчика.

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

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

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

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

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

  • 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 ― включено.
informer
enabled Разрешение отображения информера.

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

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

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

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

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

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

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

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

Значение по умолчанию: "FFFFFFFF."

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

Значение по умолчанию: "EFEFEFFF"

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

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

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

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

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

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

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

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

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

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

offline_options
offline_conversion_extended_threshold Расширенный период учета офлайн-конверсий.

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

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

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

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

Пример запроса

POST https://api-metrika.yandex.ru/management/v1/counters

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


{
    "counter
[no-highlight[

Описание

Счетчик.

]no-highlight]
" : { "id
[no-highlight[

Описание

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

]no-highlight]
" : < int > , "status
[no-highlight[

Описание

Статус счетчика.

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

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

]no-highlight]
" : < counter_status > , "owner_login
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "code_status
[no-highlight[

Описание

Статус установки кода счетчика.

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

  • CS_ERR_INFECTED — не удалось проверить (сайт, на котором установлен счетчик или одно из его зеркал находится в списке зараженных сайтов).
  • CS_NOT_FOUND — Не установлен.
  • CS_ERR_OTHER_HTML_CODE — установлен другой счетчик.
  • CS_ERR_CONNECT — не удалось проверить (ошибка соединения).
  • CS_ERR_TIMEOUT — не удалось проверить (превышено время ожидания).
  • CS_OK — Корректно установлен.

]no-highlight]
" : < code_status > , "code_status_info
[no-highlight[

Описание

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

]no-highlight]
" : { "length
[no-highlight[

Описание

Длина контента в байтах.

]no-highlight]
" : < integer > , "found
[no-highlight[

Описание

Количество найденных валидных кодов Яндекс.Метрики.

]no-highlight]
" : < integer > , "match
[no-highlight[

Описание

Количество найденных валидных кодов проверяемого счетчика.

]no-highlight]
" : < integer > , "http_code
[no-highlight[

Описание

HTTP-код ответа («200» при успешном выполнении).

]no-highlight]
" : < integer > , "http_msg
[no-highlight[

Описание

Строковое отображение HTTP-кода ответа («OK» при успешном выполнении).

]no-highlight]
" : < string > , "duration
[no-highlight[

Описание

Время ответа сайта в секундах.

]no-highlight]
" : < double > , "infected
[no-highlight[

Описание

Инфицированный сайт (сайт, на котором установлен счетчик или одно из его зеркал).

]no-highlight]
" : < string > }, "name
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "site
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "type
[no-highlight[

Описание

Тип счетчика.

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

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

]no-highlight]
" : < counter_type > , "favorite
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "permission
[no-highlight[

Описание

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

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

  • view — гостевой счетчик с уровнем доступа «только просмотр»;
  • edit — гостевой счетчик с уровнем доступа «полный доступ».
  • own — счетчик, принадлежащий пользователю;

]no-highlight]
" : < counter_permission > , "mirrors
[no-highlight[

Описание

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

]no-highlight]
" : [ < string > , ... ], "goals
[no-highlight[

Описание

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

]no-highlight]
" : [ < goal > , ... ], "filters
[no-highlight[

Описание

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

]no-highlight]
" : [ { "id
[no-highlight[

Описание

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

]no-highlight]
" : < int > , "attr
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < filter_attribute > , "type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < filter_type > , "value
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "action
[no-highlight[

Описание

Тип фильтра.

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

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

]no-highlight]
" : < filter_action > , "status
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < filter_status > , "start_ip
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "end_ip
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "with_subdomains
[no-highlight[

Описание

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

]no-highlight]
" : < boolean > }, ... ], "operations
[no-highlight[

Описание

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

]no-highlight]
" : [ { "id
[no-highlight[

Описание

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

]no-highlight]
" : < int > , "action
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < operation_type > , "attr
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < operation_attribute > , "value
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "status
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < operation_status > }, ... ], "grants
[no-highlight[

Описание

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

]no-highlight]
" : [ { "user_login
[no-highlight[

Описание

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

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

]no-highlight]
" : < string > , "perm
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < grant_type > , "created_at
[no-highlight[

Описание

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

]no-highlight]
" : < date > , "comment
[no-highlight[

Описание

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

]no-highlight]
" : < string > }, ... ], "labels
[no-highlight[

Описание

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

]no-highlight]
" : [ { "id
[no-highlight[

Описание

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

]no-highlight]
" : < int > , "name
[no-highlight[

Описание

Имя метки.

]no-highlight]
" : < string > }, ... ], "webvisor
[no-highlight[

Описание

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

]no-highlight]
" : { "urls
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "arch_enabled
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "arch_type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < webvisor_arch_type > , "load_player_type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < webvisor_load_player_type > , "wv_version
[no-highlight[

Описание

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

]no-highlight]
" : < int > }, "code_options
[no-highlight[

Описание

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

]no-highlight]
" : { "async
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "informer
[no-highlight[

Описание

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

]no-highlight]
" : { "enabled
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "type
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < informer_type > , "size
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > , "indicator
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < informer_metric > , "color_start
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "color_end
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "color_text
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > , "color_arrow
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > }, "visor
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "ut
[no-highlight[

Описание

Запрет отправки на индексацию страниц сайта.

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

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

]no-highlight]
" : < boolean > , "track_hash
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "xml_site
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "clickmap
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "in_one_line
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < boolean > , "ecommerce
[no-highlight[

Описание

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

  • 0 ― отключено (по умолчанию);
  • 1 ― включено.
]no-highlight]
" : < boolean > }, "create_time
[no-highlight[

Описание

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

]no-highlight]
" : < date > , "time_zone_name
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "time_zone_offset
[no-highlight[

Описание

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

]no-highlight]
" : < int > , "update_time
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "code
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "monitoring
[no-highlight[

Описание

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

]no-highlight]
" : { "enable_monitoring
[no-highlight[

Описание

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

  • 0 — пользователь не подписан на уведомления (по умолчанию);
  • 1 — включена подписка на уведомления мониторинга.
]no-highlight]
" : < int > , "emails
[no-highlight[

Описание

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

]no-highlight]
" : [ < string > , ... ], "sms_allowed
[no-highlight[

Описание

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

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

  • 0 — пользователь не указал номер мобильного телефона;
  • 1 — пользователь указал номер телефона и подтвердил подписку.
]no-highlight]
" : < int > , "enable_sms
[no-highlight[

Описание

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

  • 0 — пользователь не подписан на SMS-уведомления (по умолчанию);
  • 1 — включена подписка на SMS-уведомления мониторинга.
]no-highlight]
" : < int > , "sms_time
[no-highlight[

Описание

Разрешенные часовые диапазоны для отправки 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. Компоненты таких диапазонов разделяются запятой.

]no-highlight]
" : < string > , "phones
[no-highlight[

Описание

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

]no-highlight]
" : [ < string > , ... ] }, "filter_robots
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < integer > , "visit_threshold
[no-highlight[

Описание

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

]no-highlight]
" : < integer > , "offline_options
[no-highlight[

Описание

Настройки офлайн-событий.

]no-highlight]
" : { "offline_conversion_extended_threshold
[no-highlight[

Описание

Расширенный период учета офлайн-конверсий.

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

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

]no-highlight]
" : < boolean > , "offline_calls_extended_threshold
[no-highlight[

Описание

Расширенный период учета звонков.

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

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

]no-highlight]
" : < boolean > } } }
ПараметрыОписание
counter Счетчик.
counter
id Идентификатор счетчика.
status Статус счетчика.

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

  • Active — Счетчик активен
  • Deleted — Счетчик удален
owner_login Логин владельца счетчика.
code_status Статус установки кода счетчика.

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

  • CS_ERR_INFECTED — не удалось проверить (сайт, на котором установлен счетчик или одно из его зеркал находится в списке зараженных сайтов).
  • CS_NOT_FOUND — Не установлен.
  • CS_ERR_OTHER_HTML_CODE — установлен другой счетчик.
  • CS_ERR_CONNECT — не удалось проверить (ошибка соединения).
  • CS_ERR_TIMEOUT — не удалось проверить (превышено время ожидания).
  • CS_OK — Корректно установлен.
code_status_info Информация о статусе счетчика.
name Наименование счетчика.
site Полный домен сайта.
type Тип счетчика.

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

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

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

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

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

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

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

monitoring

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

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

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

  • 0 — учитывать визиты всех роботов;
  • 1 — фильтровать роботов только по строгим правилам (по умолчанию);
  • 2 — фильтровать роботов по строгим правилам и по поведению.
visit_threshold Тайм-аут визита в секундах.
offline_options Настройки офлайн-событий.
code_status_info
length Длина контента в байтах.
found Количество найденных валидных кодов Яндекс.Метрики.
match Количество найденных валидных кодов проверяемого счетчика.
http_code HTTP-код ответа («200» при успешном выполнении).
http_msg Строковое отображение HTTP-кода ответа («OK» при успешном выполнении).
duration Время ответа сайта в секундах.
infected Инфицированный сайт (сайт, на котором установлен счетчик или одно из его зеркал).
filters
id

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

comment

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

labels
id Идентификатор метки.
name Имя метки.
webvisor
urls Список страниц для сохранения.
arch_enabled Сохранение страниц сайта.

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

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

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

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

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

  • proxy — от имени анонимного пользователя;
  • on_your_behalf — от вашего имени.
wv_version Версия вебвизора.
code_options
async Асинхронный код счетчика.

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

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

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

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

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

  • 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 ― включено.
informer
enabled Разрешение отображения информера.

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

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

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

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

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

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

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

  • visits — визиты;
  • pageviews — просмотры (по умолчанию);
  • 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

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

offline_options
offline_conversion_extended_threshold Расширенный период учета офлайн-конверсий.

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

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

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

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