- Request
- Responses
- 200 OK
- Body
- CounterBrief
- CodeOptionsE
- FilterE
- ActionGoal
- CompositeGoal
- DepthGoal
- EmailGoal
- FileGoal
- MessengerGoal
- PaymentSystemGoal
- PhoneGoal
- SiteSearchGoal
- SocialNetworkGoal
- UrlGoal
- VisitDurationGoal
- CounterGrantE
- AccessFiltersGrantE
- Label
- CounterMirrorE
- OperationE
- WebvisorOptions
- InformerOptionsE
- GoalCondition
- ConditionalGoal
- AccessFiltersShortE
Список доступных счетчиков
Возвращает список существующих счетчиков, доступных пользователю.
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 Один или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: |
label_id |
Type: integer<int32> Фильтр по метке. |
offset |
Type: integer<int32> Порядковый номер счетчика, с которого начнется выдача списка счетчиков. Первый счетчик имеет номер 1. Default: |
per_page |
Type: integer<int32> Количество счетчиков, которые вы хотите получить. Default: |
permission |
Type: string Фильтр по уровню доступа к счетчику. Параметр может содержать несколько значений, разделенных запятой:
|
reverse |
Type: boolean Выдать счетчики в обратном или прямом порядке сортировки. Default: |
robots |
Type: boolean Учитывать ли роботов Default: |
search_string |
Type: string Фильтр по строке. Можно указать:
Будут показаны счетчики, имя, сайт или зеркала которых содержат заданную подстроку. При фильтрации по идентификатору укажите его полностью. |
sort |
Type: string Сортировка:
Default: |
status |
Type: string Фильтр по статусу счетчика. По умолчанию включен.
Default: |
type |
Type: string Фильтр по типу счетчика.
|
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,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"steps": [
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
}
]
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"depth": 0
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string",
"hide_phone_number": false
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"conditions": [
{
"type": "string",
"url": "string"
}
],
"flag": "string"
},
{
"id": 0,
"name": "string",
"type": "string",
"default_price": 0,
"goal_source": "string",
"is_favorite": false,
"status": "string",
"duration": 0
}
],
"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",
"perm": "string",
"created_at": "2022-12-29T18:02:01Z",
"comment": "string",
"partner_data_access": false
},
{
"user_login": "string",
"perm": "string",
"created_at": "2022-12-29T18:02:01Z",
"comment": "string",
"partner_data_access": false,
"access_filters": [
{
"id": 0,
"name": "string"
}
]
}
],
"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> Количество счетчиков, удовлетворяющих запросу, без учета параметров |
CounterBrief
Name |
Description |
activity_status |
Type: string Посещаемость счетчика. Возможные значения:
|
code_options |
Type: CodeOptionsE Настройки кода счетчика. |
create_time |
Type: string<date-time> Дата и время создания счетчика. |
favorite |
Type: boolean Добавлен ли счетчик в избранное:
|
filters |
Type: FilterE[] Список структур с информацией о фильтрах счетчика. |
gdpr_agreement_accepted |
Type: boolean Согласие с Договором об обработке данных в сервисе Яндекс Метрика.
|
goals |
Type: (ActionGoal or CompositeGoal or DepthGoal or EmailGoal or FileGoal or MessengerGoal or PaymentSystemGoal or PhoneGoal or SiteSearchGoal or SocialNetworkGoal or UrlGoal or VisitDurationGoal)[] Список структур с информацией о целях счетчика. |
grants |
Type: (CounterGrantE or AccessFiltersGrantE)[] |
id |
Type: integer<int32> Идентификатор счетчика. |
labels |
Type: Label[] Список структур с информацией о метках. |
mirrors2 |
Type: CounterMirrorE[] Список зеркал (доменов) сайта. |
name |
Type: string Наименование счетчика. Min length: Max length: |
operations |
Type: OperationE[] Список структур с информацией об операциях счетчика. |
owner_login |
Type: string Логин владельца счетчика. |
permission |
Type: string Уровень доступа к счетчику:
|
site2 |
Type: CounterMirrorE Список зеркал (доменов) сайта. |
source |
Type: string Тип счетчика. Возможные значения:
|
status |
Type: string Статус счетчика. возможные значения:
|
time_zone_name |
Type: string Часовой пояс для расчета статистики. |
time_zone_offset |
Type: integer<int32> Текущее смещение часового пояса от Гринвича, минуты. |
type |
Type: string Тип счетчика. Возможные значения:
|
webvisor |
Type: WebvisorOptions Структура с информацией о настройках Вебвизора. |
CodeOptionsE
Настройки кода счетчика.
Name |
Description |
alternative_cdn |
Type: boolean Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика:
|
async |
Type: boolean Асинхронный код счетчика:
|
clickmap |
Type: boolean Сбор статистики для работы отчета Карта кликов:
|
ecommerce |
Type: boolean Сбор данных по электронной коммерции:
|
in_one_line |
Type: boolean Выводить код счетчика в одну строку:
|
informer |
Type: InformerOptionsE Настройки информера. |
track_hash |
Type: boolean Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов:
|
visor |
Type: boolean Запись и анализ поведения посетителей сайта:
|
xml_site |
Type: boolean Для XML-сайтов. Элемент noscript не должен использоваться в XML документах:
|
ytm |
Type: boolean Использование системы управления тегами. Возможные значения:
|
FilterE
Список структур с информацией о фильтрах счетчика.
Name |
Description |
action* |
Type: string Тип фильтра:
|
attr* |
Type: string Тип данных, к которым применяется фильтр:
|
status* |
Type: string Статус фильтра:
|
type* |
Type: string Отношение или действие для фильтра:
|
end_ip |
Type: string Последний IP-адрес диапазона. |
id |
Type: integer<int32> Идентификатор фильтра. Укажите данный параметр при изменении фильтра счетчика. |
start_ip |
Type: string Первый IP-адрес диапазона. |
value |
Type: string Значение фильтра. |
with_subdomains |
Type: boolean Фильтровать по поддоменам. |
ActionGoal
JavaScript-событие.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
CompositeGoal
Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
steps* |
Type: ConditionalGoal[] Список шагов составной цели. Min items: Max items: |
type* |
Type: string Тип цели:
|
default_price |
Type: number<double> Цена цели по умолчанию. |
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
DepthGoal
Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.
Name |
Description |
depth* |
Type: integer<int64> Количество просмотренных пользователем страниц. Min value: |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
default_price |
Type: number<double> Цена цели по умолчанию. |
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
EmailGoal
Нажатие на email.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
FileGoal
Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
MessengerGoal
Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
PaymentSystemGoal
Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
default_price |
Type: number<double> Цена цели по умолчанию. |
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
PhoneGoal
Нажатие на номер телефона.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
hide_phone_number |
Type: boolean Скрывать номер телефона на десктопах. |
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
SiteSearchGoal
Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
SocialNetworkGoal
Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
UrlGoal
Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
VisitDurationGoal
Продолжительность визита. Цель будет достигнута при времени визита больше заданного.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
default_price |
Type: number<double> Цена цели по умолчанию. |
duration |
Type: integer<int32> Продолжительность визита в секундах. Min value: |
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
CounterGrantE
Список структур с информацией о правах доступа к счетчику.
Name |
Description |
perm* |
Type: string Уровень доступа:
|
comment |
Type: string Произвольный комментарий. Количество символов не должно превышать 255. Min length: Max length: |
created_at |
Type: string<date-time> Дата предоставления доступа в формате YYYY-MM-DD'T'hh:mm:ssZ. |
partner_data_access |
Type: boolean Доступ к группе отчетов «Монетизация». Пользователь сможет просматривать отчеты, добавлять группировки и метрики из группы «Монетизация» в другие отчеты. Если у пользователя есть доступ на редактирование, то ему уже доступны отчеты группы «Монетизация». Возможные значения:
|
user_login |
Type: string Логин пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит пустую строку, если к статистике счетчика предоставлен публичный доступ ( |
AccessFiltersGrantE
Name |
Description |
access_filters* |
Type: AccessFiltersShortE[] Список фильтров доступа, к которым выдано разрешение. Min items: Max items: |
perm* |
Type: string Уровень доступа:
|
comment |
Type: string Произвольный комментарий. Количество символов не должно превышать 255. Min length: Max length: |
created_at |
Type: string<date-time> Дата предоставления доступа в формате YYYY-MM-DD'T'hh:mm:ssZ. |
partner_data_access |
Type: boolean Доступ к группе отчетов «Монетизация». Пользователь сможет просматривать отчеты, добавлять группировки и метрики из группы «Монетизация» в другие отчеты. Если у пользователя есть доступ на редактирование, то ему уже доступны отчеты группы «Монетизация». Возможные значения:
|
user_login |
Type: string Логин пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит пустую строку, если к статистике счетчика предоставлен публичный доступ ( |
Label
Метка.
Name |
Description |
id |
Type: integer<int32> Идентификатор метки. |
name |
Type: string Имя метки. Min length: Max length: |
CounterMirrorE
Список зеркал (доменов) сайта.
Name |
Description |
site* |
Type: string Полный домен сайта. Min length: Max length: |
OperationE
Список структур с информацией об операциях счетчика.
Name |
Description |
action* |
Type: string Тип операции:
|
attr* |
Type: string Поле для фильтрации:
|
status* |
Type: string Статус операции:
|
id |
Type: integer<int32> Идентификатор операции (требуется указывать при изменении операции счетчика). |
value |
Type: string Значение для замены. |
WebvisorOptions
Структура с информацией о настройках Вебвизора.
Name |
Description |
arch_enabled |
Type: boolean Сохранение страниц сайта:
|
arch_type |
Type: string Запись содержимого страниц:
|
load_player_type |
Type: string Загрузка страниц в плеер:
|
urls |
Type: string Список страниц для сохранения. Min length: Max length: |
wv_forms |
Type: boolean Запись содержимого полей и форм:
|
wv_version |
Type: integer<int32> Версия вебвизора. |
InformerOptionsE
Настройки информера.
Name |
Description |
color_arrow |
Type: integer<int32> Цвет стрелки на информере:
Min value: Max value: |
color_end |
Type: string Конечный (нижний) цвет информера в формате RRGGBBAA. Параметр предназначен для создания градиента фона. Насыщенность и прозрачность цвета задаются аналогично параметру color_start. Default: Pattern: |
color_start |
Type: string Начальный (верхний) цвет информера в формате RRGGBBAA. RR, GG, BB ― насыщенность красного, зеленого и синего цвета. Насыщенность каждого цвета задается значениями в диапазоне от 00 до FF. AA ― прозрачность от 00 (прозрачный) до FF (непрозрачный). Default: Pattern: |
color_text |
Type: integer<int32> Цвет текста на информере:
Min value: Max value: |
enabled |
Type: boolean Разрешение отображения информера:
|
indicator |
Type: string Показатель, который будет отображаться на информере:
|
size |
Type: integer<int32> Размер информера:
Min value: Max value: |
type |
Type: string Тип информера:
|
GoalCondition
Список структур с условиями цели.
Name |
Description |
type* |
Type: string Тип условия:
|
url |
Type: string Значение зависит от типа цели:
|
ConditionalGoal
Список шагов составной цели.
Name |
Description |
name* |
Type: string Наименование цели. Min length: Max length: |
type* |
Type: string Тип цели:
|
conditions |
Type: GoalCondition[] Список структур с условиями цели. |
default_price |
Type: number<double> Цена цели по умолчанию. |
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
|
goal_source |
Type: string Признак того, как создана цель:
|
id |
Type: integer<int64> Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
is_favorite |
Type: boolean Является ли цель избранной:
|
status |
Type: string |
AccessFiltersShortE
Список фильтров доступа, к которым выдано разрешение.
Name |
Description |
id |
Type: integer<int32> id фильтра доступа. |
name |
Type: string Название фильтра доступа. |
No longer supported, please use an alternative and newer version.