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

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

Request

GET

https://api-metrika.yandex.net/management/v1/counters

Query parameters

Name

Description

callback

Type: string

Функция обратного вызова, которая обрабатывает ответ API.

counter_ids

Type: integer<int32>[]

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

favorite

Type: boolean

Фильтр по счетчикам, которые были добавлены в Избранные.

Default:

field

Type: string

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

label_id

Type: integer<int32>

Фильтр по метке.

offset

Type: integer<int32>

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

Default: 1

per_page

Type: integer<int32>

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

Default: 1000

permission

Type: string

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

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

reverse

Type: boolean

Выдать счетчики в обратном или прямом порядке сортировки.

Default:

robots

Type: boolean

Учитывать ли роботов

Default:

search_string

Type: string

Фильтр по строке. Можно указать:

  • идентификатор счетчика;
  • название счетчика;
  • адрес сайта, на котором установлен счетчик;
  • дополнительный адрес.

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

sort

Type: string

Сортировка:

  • None — без сортировки;
  • Default – по умолчанию;
  • Visits – количество визитов;
  • Hits – количество хитов;
  • Uniques – количество посетителей;
  • Name – название счетчика.

Default: Default

status

Type: string

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

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

Default: Active

type

Type: string

Фильтр по типу счетчика.
Тип счетчика. Возможные значения:

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

Responses

200 OK

OK

Body

application/json
{
    "rows": 0,
    "counters": [
        {
            "id": 0,
            "status": "string",
            "owner_login": "string",
            "activity_status": "string",
            "name": "string",
            "type": "string",
            "favorite": false,
            "permission": "string",
            "goals": [
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false
                }
            ],
            "filters": [
                {
                    "id": 0,
                    "attr": "string",
                    "type": "string",
                    "value": "string",
                    "action": "string",
                    "status": "string",
                    "start_ip": "string",
                    "end_ip": "string",
                    "with_subdomains": false
                }
            ],
            "operations": [
                {
                    "id": 0,
                    "action": "string",
                    "attr": "string",
                    "value": "string",
                    "status": "string"
                }
            ],
            "grants": [
                {
                    "user_login": "string",
                    "user_uid": 0,
                    "perm": "string",
                    "created_at": "2022-12-29T18:02:01Z",
                    "comment": "string",
                    "partner_data_access": false
                }
            ],
            "labels": [
                {
                    "id": 0,
                    "name": "string"
                }
            ],
            "webvisor": {
                "urls": "string",
                "arch_enabled": false,
                "arch_type": "string",
                "load_player_type": "string",
                "wv_version": 0,
                "wv_forms": false
            },
            "code_options": {
                "async": false,
                "informer": {
                    "enabled": false,
                    "type": "string",
                    "size": 0,
                    "indicator": "string",
                    "color_start": "FFFFFFFF.",
                    "color_end": "EFEFEFFF",
                    "color_text": 0,
                    "color_arrow": 0
                },
                "visor": false,
                "track_hash": false,
                "xml_site": false,
                "clickmap": false,
                "in_one_line": false,
                "ecommerce": false,
                "alternative_cdn": false,
                "ytm": false
            },
            "create_time": "2022-12-29T18:02:01Z",
            "time_zone_name": "string",
            "time_zone_offset": 0,
            "source": "string",
            "site2": {
                "site": "string"
            },
            "gdpr_agreement_accepted": false,
            "mirrors2": [
                {
                    "site": "string"
                }
            ]
        }
    ]
}

Name

Description

counters

Type: CounterBrief[]

Список счетчиков.

rows

Type: integer<int32>

Количество счетчиков, удовлетворяющих запросу, без учета параметров offset и per_page.

CounterBrief

Name

Description

activity_status

Type: string

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

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

code_options

Type: CodeOptionsE

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

create_time

Type: string<date-time>

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

favorite

Type: boolean

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

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

filters

Type: FilterE[]

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

gdpr_agreement_accepted

Type: boolean

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

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

goals

Type: GoalE[]

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

grants

Type: CounterGrantE[]

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

id

Type: integer<int32>

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

labels

Type: Label[]

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

mirrors2

Type: CounterMirrorE[]

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

name

Type: string

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

Min length: 0

Max length: 255

operations

Type: OperationE[]

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

owner_login

Type: string

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

permission

Type: string

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

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

site2

Type: CounterMirrorE

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

source

Type: string

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

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

status

Type: string

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

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

time_zone_name

Type: string

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

time_zone_offset

Type: integer<int32>

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

type

Type: string

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

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

webvisor

Type: WebvisorOptions

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

CodeOptionsE

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

Name

Description

alternative_cdn

Type: boolean

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

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

async

Type: boolean

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

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

clickmap

Type: boolean

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

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

ecommerce

Type: boolean

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

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

in_one_line

Type: boolean

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

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

informer

Type: InformerOptionsE

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

track_hash

Type: boolean

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

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

visor

Type: boolean

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

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

xml_site

Type: boolean

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

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

ytm

Type: boolean

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

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

FilterE

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

Name

Description

action*

Type: string

Тип фильтра:

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

attr*

Type: string

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

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

status*

Type: string

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

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

type*

Type: string

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

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

end_ip

Type: string

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

id

Type: integer<int32>

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

start_ip

Type: string

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

value

Type: string

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

with_subdomains

Type: boolean

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

GoalE

Name

Description

name*

Type: string

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

Min length: 0

Max length: 255

type*

Type: string

Тип цели:

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

default_price

Type: number<double>

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

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

CounterGrantE

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

Name

Description

perm*

Type: string

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

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

comment

Type: string

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

Min length: 0

Max length: 255

created_at

Type: string<date-time>

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

partner_data_access

Type: boolean

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

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

user_login

Type: string

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

user_uid

Type: integer<int64>

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

Примечание

Опциональный параметр при использовании в запросе.

Label

Метка.

Name

Description

id

Type: integer<int32>

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

name

Type: string

Имя метки.

Min length: 0

Max length: 255

CounterMirrorE

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

Name

Description

site*

Type: string

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

Min length: 0

Max length: 255

OperationE

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

Name

Description

action*

Type: string

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

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

attr*

Type: string

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

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

status*

Type: string

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

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

id

Type: integer<int32>

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

value

Type: string

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

WebvisorOptions

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

Name

Description

arch_enabled

Type: boolean

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

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

arch_type

Type: string

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

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

load_player_type

Type: string

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

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

urls

Type: string

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

Min length: 0

Max length: 2000

wv_forms

Type: boolean

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

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

wv_version

Type: integer<int32>

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

InformerOptionsE

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

Name

Description

color_arrow

Type: integer<int32>

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

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

Min value: 0

Max value: 1

color_end

Type: string

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

Default: EFEFEFFF

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

color_start

Type: string

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

Default: FFFFFFFF.

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

color_text

Type: integer<int32>

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

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

Min value: 0

Max value: 1

enabled

Type: boolean

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

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

indicator

Type: string

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

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

size

Type: integer<int32>

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

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

Min value: 1

Max value: 3

type

Type: string

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

  • simple — простой.
  • ext — расширенный (по умолчанию).
Предыдущая
Удаление счетчика
Следующая
Создание счетчика