Список доступных счетчиков

Возвращает список существующих счетчиков, доступных пользователю.

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

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

https://api-metrika.yandex.ru/management/v1/counters
 ? [callback=<string>]
 & [favorite=<boolean>]
 & [field=<string>]
 & [label_id=<integer>]
 & [offset=<int>]
 & [per_page=<int>]
 & [permission=<string>]
 & [reverse=<boolean>]
 & [search_string=<string>]
 & [sort=<counters_sort>]
 & [status=<counter_status>]
 & [type=<counter_type>]
Query-параметры
callbackФункция обратного вызова, которая обрабатывает ответ API.
favoriteФильтр по счетчикам, которые были добавлены в Избранные.

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

field

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

label_idФильтр по метке.
offsetПорядковый номер счетчика, с которого начнется выдача списка счетчиков. Первый счетчик имеет номер 1.

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

per_pageКоличество счетчиков, которые вы хотите получить.

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

permission

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

Допустимые значения:

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

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

search_stringФильтр по строке. Будут показаны счетчики, идентификатор, имя, сайт или зеркала которых содержат заданную подстроку.
sortСортировка

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

Допустимые значения:

  • Uniques — Количество посетителей
  • Hits — Количество хитов
  • Visits — Количество визитов
  • Default — По умолчанию
  • None — Без сортировки
  • Name — Название счетчика
statusФильтр по статусу счетчика. По умолчанию включен.

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

Допустимые значения:

  • Active — Счетчик активен
  • Deleted — Счетчик удален
typeФильтр по типу счетчика.

Допустимые значения:

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

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


{
    "rows" :  < int > ,
    "counters" : [ {
        "id" :  < int > ,
        "status" :  < counter_status > ,
        "owner_login" :  < string > ,
        "code_status" :  < code_status > ,
        "code_status_info" : {
            "length" :  < integer > ,
            "found" :  < integer > ,
            "match" :  < integer > ,
            "http_code" :  < integer > ,
            "http_msg" :  < string > ,
            "duration" :  < double > ,
            "infected" :  < string > 
        },
        "name" :  < string > ,
        "site2" : {
            "site" :  < string > 
        },
        "type" :  < counter_type > ,
        "favorite" :  < 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 > ,
            "perm" :  < grant_type > ,
            "created_at" :  < date > ,
            "comment" :  < string > 
        }, ... ],
        "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 > ,
            "ut" :  < boolean > ,
            "track_hash" :  < boolean > ,
            "xml_site" :  < boolean > ,
            "clickmap" :  < boolean > ,
            "in_one_line" :  < boolean > ,
            "ecommerce" :  < boolean > 
        },
        "create_time" :  < date > ,
        "time_zone_name" :  < string > ,
        "time_zone_offset" :  < int > 
    }, ... ]
}
Параметры Описание
rows Количество счетчиков, удовлетворяющих запросу, без учета параметров offset и per_page.
counters Список счетчиков.
counters
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 Наименование счетчика.
site2 Полный домен сайта.
type Тип счетчика.

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

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

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

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

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

  • view — гостевой счетчик с уровнем доступа «только просмотр»;
  • edit — гостевой счетчик с уровнем доступа «полный доступ».
  • own — счетчик, принадлежащий пользователю;
mirrors2 Список зеркал (доменов) сайта.
goals Список структур с информацией о целях счетчика.
filters Список структур с информацией о фильтрах счетчика.
operations Список структур с информацией об операциях счетчика.
grants Список структур с информацией о правах доступа к счетчику.
labels Список структур с информацией о метках.
webvisor Структура с информацией о настройках Вебвизора.
code_options Настройки кода счетчика.
create_time Дата и время создания счетчика.
time_zone_name Часовой пояс для расчета статистики.
time_zone_offset Текущее смещение часового пояса от Гринвича, минуты
code_status_info
length Длина контента в байтах.
found Количество найденных валидных кодов Яндекс.Метрики.
match Количество найденных валидных кодов проверяемого счетчика.
http_code HTTP-код ответа («200» при успешном выполнении).
http_msg Строковое отображение HTTP-кода ответа («OK» при успешном выполнении).
duration Время ответа сайта в секундах.
infected Инфицированный сайт (сайт, на котором установлен счетчик или одно из его зеркал).
site2
site Полный домен сайта.
mirrors2
site Полный домен сайта.
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 Версия вебвизора.
wv_forms Запись содержимого полей и форм.

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

  • 0 - не записывать содержимое полей и форм за исключением тех из них, которые помечены css-классом -metrika-recordkeys;
  • 1 - записывать содержимое полей и форм за исключением тех из них, которые помечены css-классом -metrika-nokeys (по умолчанию).
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 ― фиолетовый (по умолчанию).