Список доступных счетчиков
Возвращает список существующих счетчиков, доступных пользователю.
Синтаксис запроса
https://api-metrika.yandex.net/management/v1/counters
? [callback=<string>]
& [counter_ids=<list>]
& [favorite=<boolean>]
& [field=<string>]
& [label_id=<integer>]
& [offset=<int>]
& [per_page=<int>]
& [permission=<string>]
& [reverse=<boolean>]
& [robots=<boolean>]
& [search_string=<string>]
& [sort=<counters_sort>]
& [status=<counter_status>]
& [type=<counter_type>]
callback | Функция обратного вызова, которая обрабатывает ответ API. |
counter_ids | Список идентификаторов счетчиков, которые вы хотите получить. |
favorite | Фильтр по счетчикам, которые были добавлены в Избранные. Значение по умолчанию: 0 |
field | Один или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: |
label_id | Фильтр по метке. |
offset | Порядковый номер счетчика, с которого начнется выдача списка счетчиков. Первый счетчик имеет номер 1. Значение по умолчанию: 1 |
per_page | Количество счетчиков, которые вы хотите получить. Значение по умолчанию: 1000 |
permission | Фильтр по уровню доступа к счетчику. Параметр может содержать несколько значений, разделенных запятой. Допустимые значения:
|
reverse | Выдать счетчики в обратном или прямом порядке сортировки. Значение по умолчанию: true |
robots | Учитывать ли роботов Значение по умолчанию: true |
search_string | Фильтр по строке. Можно указать:
Будут показаны счетчики, имя, сайт или зеркала которых содержат заданную подстроку. При фильтрации по идентификатору укажите его полностью. |
sort | Сортировка Значение по умолчанию: Default Допустимые значения:
|
status | Фильтр по статусу счетчика. По умолчанию включен. Значение по умолчанию: Active Допустимые значения:
|
type | Фильтр по типу счетчика. Допустимые значения:
|
callback | Функция обратного вызова, которая обрабатывает ответ API. |
counter_ids | Список идентификаторов счетчиков, которые вы хотите получить. |
favorite | Фильтр по счетчикам, которые были добавлены в Избранные. Значение по умолчанию: 0 |
field | Один или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: |
label_id | Фильтр по метке. |
offset | Порядковый номер счетчика, с которого начнется выдача списка счетчиков. Первый счетчик имеет номер 1. Значение по умолчанию: 1 |
per_page | Количество счетчиков, которые вы хотите получить. Значение по умолчанию: 1000 |
permission | Фильтр по уровню доступа к счетчику. Параметр может содержать несколько значений, разделенных запятой. Допустимые значения:
|
reverse | Выдать счетчики в обратном или прямом порядке сортировки. Значение по умолчанию: true |
robots | Учитывать ли роботов Значение по умолчанию: true |
search_string | Фильтр по строке. Можно указать:
Будут показаны счетчики, имя, сайт или зеркала которых содержат заданную подстроку. При фильтрации по идентификатору укажите его полностью. |
sort | Сортировка Значение по умолчанию: Default Допустимые значения:
|
status | Фильтр по статусу счетчика. По умолчанию включен. Значение по умолчанию: Active Допустимые значения:
|
type | Фильтр по типу счетчика. Допустимые значения:
|
Пример запроса
https://api-metrika.yandex.net/management/v1/counters
Формат ответа
{
"rows" : < int > ,
"counters" : [ {
"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 >
}, ... ]
}
Параметры | Описание |
---|---|
rows | Количество счетчиков, удовлетворяющих запросу, без учета параметров offset и per_page . |
counters | Список счетчиков. |
counters | |
id | Идентификатор счетчика. |
status | Статус счетчика. Возможные значения:
|
owner_login | Логин владельца счетчика. |
code_status | Статус установки кода счетчика. Внимание. Параметр устарел — не используйте его при работе с данными. В качестве значения всегда возвращается CS_ERR_UNKNOWN (неизвестная ошибка). В будущем code_status будет удален. |
activity_status | Посещаемость счетчика. |
name | Наименование счетчика. |
site2 | Полный домен сайта. |
type | Тип счетчика. Возможные значения:
|
favorite | Добавлен ли счетчик в избранное. Возможные значения:
|
gdpr_agreement_accepted | Согласие с Договором об обработке данных в сервисе «Яндекс.Метрика». Возможные значения:
|
permission | Уровень доступа к счетчику. Возможные значения:
|
mirrors2 | Список зеркал (доменов) сайта. |
goals | Список структур с информацией о целях счетчика. |
filters | Список структур с информацией о фильтрах счетчика. |
operations | Список структур с информацией об операциях счетчика. |
grants | Список структур с информацией о правах доступа к счетчику. |
labels | Список структур с информацией о метках. |
webvisor | Структура с информацией о настройках Вебвизора. |
code_options | Настройки кода счетчика. |
create_time | Дата и время создания счетчика. |
time_zone_name | Часовой пояс для расчета статистики. |
time_zone_offset | Текущее смещение часового пояса от Гринвича, минуты. |
source | Тип счетчика |
site2 | |
site | Полный домен сайта. |
mirrors2 | |
site | Полный домен сайта. |
filters | |
id | Идентификатор фильтра. Укажите данный параметр при изменении фильтра счетчика |
attr | Тип данных, к которым применяется фильтр. Возможные значения:
|
type | Отношение или действие для фильтра. Возможные значения:
|
value | Значение фильтра. |
action | Тип фильтра. Возможные значения:
|
status | Статус фильтра. Возможные значения:
|
start_ip | Первый IP-адрес диапазона. |
end_ip | Последний IP-адрес диапазона. |
with_subdomains | Фильтровать по поддоменам. |
operations | |
id | Идентификатор операции (требуется указывать при изменении операции счетчика). |
action | Тип операции. Возможные значения:
|
attr | Поле для фильтрации. Возможные значения:
|
value | Значение для замены. |
status | Статус операции. Возможные значения:
|
grants | |
user_login | Логин пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит пустую строку, если к статистике счетчика предоставлен публичный доступ ( |
user_uid | uid пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит 0, если к статистике счетчика предоставлен публичный доступ ( |
perm | Уровень доступа. Возможные значения:
|
created_at | Дата предоставления доступа в формате YYYY-MM-DD'T'hh:mm:ssZ. |
comment | Произвольный комментарий. Количество символов не должно превышать 255. |
partner_data_access | Доступ к группе отчетов «Монетизация». Пользователь сможет просматривать отчеты, добавлять группировки и метрики из группы «Монетизация» в другие отчеты. Если у пользователя есть доступ на редактирование, то ему уже доступны отчеты группы «Монетизация». Возможные значения:
|
labels | |
id | Идентификатор метки. |
name | Имя метки. |
webvisor | |
urls | Список страниц для сохранения. |
arch_enabled | Сохранение страниц сайта. Возможные значения:
|
arch_type | Запись содержимого страниц. Возможные значения:
|
load_player_type | Загрузка страниц в плеер. Возможные значения:
|
wv_version | Версия вебвизора. |
wv_forms | Запись содержимого полей и форм. Возможные значения:
|
code_options | |
async | Асинхронный код счетчика. Возможные значения:
|
informer | Настройки информера. |
visor | Запись и анализ поведения посетителей сайта. Возможные значения:
|
track_hash | Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов. Возможные значения:
|
xml_site | Для XML-сайтов. Элемент noscript не должен использоваться в XML документах. Возможные значения:
|
clickmap | Сбор статистики для работы отчета Карта кликов. Возможные значения:
|
in_one_line | Выводить код счетчика в одну строку. Возможные значения:
|
ecommerce | Сбор данных по электронной коммерции. Возможные значения:
|
alternative_cdn | Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика. Возможные значения:
|
informer | |
enabled | Разрешение отображения информера. Возможные значения:
|
type | Тип информера. Возможные значения:
|
size | Размер информера. Возможные значения:
|
indicator | Показатель, который будет отображаться на информере. Возможные значения:
|
color_start | Начальный (верхний) цвет информера в формате RRGGBBAA. RR, GG, BB ― насыщенность красного, зеленого и синего цвета. Насыщенность каждого цвета задается значениями в диапазоне от 00 до FF. AA ― прозрачность от 00 (прозрачный) до FF (непрозрачный). |
color_end | Конечный (нижний) цвет информера в формате RRGGBBAA. Параметр предназначен для создания градиента фона. Насыщенность и прозрачность цвета задаются аналогично параметру color_start. |
color_text | Цвет текста на информере. Возможные значения:
|
color_arrow | Цвет стрелки на информере. Возможные значения:
|
Параметры | Описание |
---|---|
rows | Количество счетчиков, удовлетворяющих запросу, без учета параметров offset и per_page . |
counters | Список счетчиков. |
counters | |
id | Идентификатор счетчика. |
status | Статус счетчика. Возможные значения:
|
owner_login | Логин владельца счетчика. |
code_status | Статус установки кода счетчика. Внимание. Параметр устарел — не используйте его при работе с данными. В качестве значения всегда возвращается CS_ERR_UNKNOWN (неизвестная ошибка). В будущем code_status будет удален. |
activity_status | Посещаемость счетчика. |
name | Наименование счетчика. |
site2 | Полный домен сайта. |
type | Тип счетчика. Возможные значения:
|
favorite | Добавлен ли счетчик в избранное. Возможные значения:
|
gdpr_agreement_accepted | Согласие с Договором об обработке данных в сервисе «Яндекс.Метрика». Возможные значения:
|
permission | Уровень доступа к счетчику. Возможные значения:
|
mirrors2 | Список зеркал (доменов) сайта. |
goals | Список структур с информацией о целях счетчика. |
filters | Список структур с информацией о фильтрах счетчика. |
operations | Список структур с информацией об операциях счетчика. |
grants | Список структур с информацией о правах доступа к счетчику. |
labels | Список структур с информацией о метках. |
webvisor | Структура с информацией о настройках Вебвизора. |
code_options | Настройки кода счетчика. |
create_time | Дата и время создания счетчика. |
time_zone_name | Часовой пояс для расчета статистики. |
time_zone_offset | Текущее смещение часового пояса от Гринвича, минуты. |
source | Тип счетчика |
site2 | |
site | Полный домен сайта. |
mirrors2 | |
site | Полный домен сайта. |
filters | |
id | Идентификатор фильтра. Укажите данный параметр при изменении фильтра счетчика |
attr | Тип данных, к которым применяется фильтр. Возможные значения:
|
type | Отношение или действие для фильтра. Возможные значения:
|
value | Значение фильтра. |
action | Тип фильтра. Возможные значения:
|
status | Статус фильтра. Возможные значения:
|
start_ip | Первый IP-адрес диапазона. |
end_ip | Последний IP-адрес диапазона. |
with_subdomains | Фильтровать по поддоменам. |
operations | |
id | Идентификатор операции (требуется указывать при изменении операции счетчика). |
action | Тип операции. Возможные значения:
|
attr | Поле для фильтрации. Возможные значения:
|
value | Значение для замены. |
status | Статус операции. Возможные значения:
|
grants | |
user_login | Логин пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит пустую строку, если к статистике счетчика предоставлен публичный доступ ( |
user_uid | uid пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит 0, если к статистике счетчика предоставлен публичный доступ ( |
perm | Уровень доступа. Возможные значения:
|
created_at | Дата предоставления доступа в формате YYYY-MM-DD'T'hh:mm:ssZ. |
comment | Произвольный комментарий. Количество символов не должно превышать 255. |
partner_data_access | Доступ к группе отчетов «Монетизация». Пользователь сможет просматривать отчеты, добавлять группировки и метрики из группы «Монетизация» в другие отчеты. Если у пользователя есть доступ на редактирование, то ему уже доступны отчеты группы «Монетизация». Возможные значения:
|
labels | |
id | Идентификатор метки. |
name | Имя метки. |
webvisor | |
urls | Список страниц для сохранения. |
arch_enabled | Сохранение страниц сайта. Возможные значения:
|
arch_type | Запись содержимого страниц. Возможные значения:
|
load_player_type | Загрузка страниц в плеер. Возможные значения:
|
wv_version | Версия вебвизора. |
wv_forms | Запись содержимого полей и форм. Возможные значения:
|
code_options | |
async | Асинхронный код счетчика. Возможные значения:
|
informer | Настройки информера. |
visor | Запись и анализ поведения посетителей сайта. Возможные значения:
|
track_hash | Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов. Возможные значения:
|
xml_site | Для XML-сайтов. Элемент noscript не должен использоваться в XML документах. Возможные значения:
|
clickmap | Сбор статистики для работы отчета Карта кликов. Возможные значения:
|
in_one_line | Выводить код счетчика в одну строку. Возможные значения:
|
ecommerce | Сбор данных по электронной коммерции. Возможные значения:
|
alternative_cdn | Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика. Возможные значения:
|
informer | |
enabled | Разрешение отображения информера. Возможные значения:
|
type | Тип информера. Возможные значения:
|
size | Размер информера. Возможные значения:
|
indicator | Показатель, который будет отображаться на информере. Возможные значения:
|
color_start | Начальный (верхний) цвет информера в формате RRGGBBAA. RR, GG, BB ― насыщенность красного, зеленого и синего цвета. Насыщенность каждого цвета задается значениями в диапазоне от 00 до FF. AA ― прозрачность от 00 (прозрачный) до FF (непрозрачный). |
color_end | Конечный (нижний) цвет информера в формате RRGGBBAA. Параметр предназначен для создания градиента фона. Насыщенность и прозрачность цвета задаются аналогично параметру color_start. |
color_text | Цвет текста на информере. Возможные значения:
|
color_arrow | Цвет стрелки на информере. Возможные значения:
|