- Request
- Path parameters
- Query parameters
- Body
- GoalE
- GoalCondition
- ActionGoal
- ChatGoalCondition
- ChatGoalConditionAnswered
- ChatGoalConditionPlatform
- ChatGoalConditionTag
- ChatGoal
- ConditionalGoal
- CompositeGoal
- DepthGoal
- EmailGoal
- FileGoal
- MessengerGoal
- PaymentSystemGoal
- PhoneGoal
- SiteSearchGoal
- SocialNetworkGoal
- UrlGoal
- VisitDurationGoal
- FilterE
- OperationE
- CounterGrantE
- AccessFiltersShortE
- AccessFiltersGrantE
- Label
- WebvisorOptions
- InformerOptionsE
- CodeOptionsE
- PublisherOptions
- CounterMirrorE
- CounterCms
- CounterCrm
- SiteActivityProfile
- CounterFlags
- LocationOnPage
- CounterEdit
- CommunicationChannel
- CounterIndustry
- UserActivityProfile
- Responses
- 200 OK
Изменение счетчика
Изменяет указанный счетчик
Request
PUT
https://api-metrika.yandex.net/management/v1/counter/{counterId}
Path parameters
|
Name |
Description |
|
counterId |
Type: integer Идентификатор счетчика, информацию о котором вы хотите получить. |
Query parameters
|
Name |
Description |
|
field |
Type: string Один или несколько дополнительных параметров возвращаемого объекта. Названия дополнительных параметров указываются в любом порядке через запятую, без пробелов. Например: Example: `` |
Body
application/json
{
"counter": {
"id": 0,
"status": "example",
"owner_login": "example",
"activity_status": "example",
"name": "example",
"type": "example",
"favorite": true,
"hide_address": true,
"pro": true,
"pro_features": [
"example"
],
"permission": "example",
"goals": [
null
],
"filters": [
{
"id": 0,
"attr": "example",
"type": "example",
"value": "example",
"action": "example",
"status": "example",
"start_ip": "example",
"end_ip": "example",
"with_subdomains": true
}
],
"operations": [
{
"id": 0,
"action": "example",
"attr": "example",
"value": "example",
"status": "example"
}
],
"grants": [
{
"user_login": "example",
"user_uid": 0,
"perm": "example",
"created_at": "2025-01-01T00:00:00Z",
"comment": "example",
"email": "example",
"partner_data_access": true
}
],
"labels": [
{
"id": 0,
"name": "example"
}
],
"webvisor": {
"urls": "example",
"arch_enabled": true,
"arch_type": "example",
"load_player_type": "example",
"wv_version": 0,
"wv_forms": true
},
"code_options": {
"async": true,
"informer": {
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
},
"visor": true,
"track_hash": true,
"xml_site": true,
"clickmap": true,
"in_one_line": true,
"ecommerce": true,
"alternative_cdn": true,
"ecommerce_object": "example",
"ssr": true
},
"create_time": "2025-01-01T00:00:00Z",
"time_zone_name": "example",
"time_zone_offset": 0,
"partner_id": 0,
"title": "example",
"grants_cnt": 0,
"update_time": "example",
"delete_time": "example",
"code": "example",
"filter_robots": 1,
"currency": 0,
"currency_code": "example",
"visit_threshold": 1800,
"max_goals": 0,
"max_operations": 0,
"max_filters": 0,
"features": [
"example"
],
"publisher_options": {
"enabled": true,
"schema": "example",
"schema_options": [
"example"
]
},
"total_geo_points_count": 0,
"selected_geo_points_count": 0,
"vendor_id": 0,
"mirrors_remove": 0,
"goals_remove": 0,
"filters_remove": 0,
"operations_remove": 0,
"grants_remove": 0,
"site2": {
"site": "example",
"domain": "example",
"status": "example"
},
"gdpr_agreement_accepted": true,
"mirrors2": [
null
],
"cms": {
"code": "example",
"custom": "example"
},
"crm": {
"code": "example",
"custom": "example"
},
"communication_channel": [
{
"code": "example",
"custom": "example"
}
],
"industry": [
{
"code": "example",
"custom": "example"
}
],
"site_activity": {
"code": "example",
"custom": "example"
},
"user_activity": [
{
"code": "example",
"custom": "example"
}
],
"autogoals_enabled": true,
"ecommerce_deduplicator_enabled": true,
"counter_flags": {
"counter_id": 0,
"use_in_benchmarks": true,
"direct_allow_use_goals_without_access": true,
"incognito": "example",
"collect_first_party_data": true,
"collect_masked_first_party_data": true,
"statistics_over_site": true,
"measurement_enabled": true,
"vendor_data": true,
"allow_use_data_to_collect_feedback": true
},
"measurement_tokens": [
"example"
]
}
}
|
Name |
Description |
|
counter |
Type: CounterEdit Счетчик. Example
|
GoalE
|
Name |
Description |
|
name |
Type: string Наименование цели. Min length: Max length: Example: |
|
type |
Type: string Тип цели:
Example: |
|
default_price |
Type: number Цена цели по умолчанию. |
|
id |
Type: integer Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
|
is_favorite |
Type: boolean Является ли цель избранной:
|
|
status |
Type: string Example: |
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_favorite": true,
"status": "example"
}
GoalCondition
Список структур с условиями цели.
|
Name |
Description |
|
type |
Type: string Тип условия:
Example: |
|
url |
Type: string Значение зависит от типа цели:
Example: |
Example
{
"type": "example",
"url": "example"
}
ActionGoal
JavaScript-событие.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
ChatGoalCondition
Список структур с условиями цели.
|
Name |
Description |
|
field |
Type: string К чему применять цель. Example: |
Example
{
"field": "example"
}
ChatGoalConditionAnswered
All of 2 types
-
Type: ChatGoalCondition
Список структур с условиями цели.
Example
{ "field": "example" } -
Type: object
answered
Type: boolean
Статус ответа в чате.
Example
{ "answered": true }
Example
{
"field": "example",
"answered": true
}
ChatGoalConditionPlatform
All of 2 types
-
Type: ChatGoalCondition
Список структур с условиями цели.
Example
{ "field": "example" } -
Type: object
platform
Type: string
Платформа чата. Возможные значения:
telegram;viber;whatsApp.
Example:
telegramExample
{ "platform": "telegram" }
Example
{
"field": "example",
"platform": "telegram"
}
ChatGoalConditionTag
All of 2 types
-
Type: ChatGoalCondition
Список структур с условиями цели.
Example
{ "field": "example" } -
Type: object
operator
Type: string
Тип условия. Возможные значения:
contain— содержит.exact— совпадает.start— начинается с.regexp— удовлетворяет регулярному выражению.
Example:
examplevalue
Type: string
Min length:
1Max length:
1024Example:
exampleExample
{ "operator": "example", "value": "example" }
Example
{
"field": "example",
"operator": "example",
"value": "example"
}
ChatGoal
Нажатие на чат.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: array
One of 3 types
-
Type: ChatGoalConditionAnswered
Example
{ "field": "example", "answered": true } -
Type: ChatGoalConditionPlatform
Example
{ "field": "example", "platform": "telegram" } -
Type: ChatGoalConditionTag
Example
{ "field": "example", "operator": "example", "value": "example" }
Example
[ { "field": "example", "answered": true } ]Example
{ "conditions": [ { "field": "example", "answered": true } ] } -
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
null
]
}
ConditionalGoal
Список шагов составной цели.
|
Name |
Description |
|
name |
Type: string Наименование цели. Min length: Max length: Example: |
|
type |
Type: string Тип цели:
Example: |
|
conditions |
Type: GoalCondition[] Example
|
|
default_price |
Type: number Цена цели по умолчанию. |
|
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
Example: |
|
id |
Type: integer Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
|
is_favorite |
Type: boolean Является ли цель избранной:
|
|
status |
Type: string Example: |
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
CompositeGoal
Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
steps
Type: ConditionalGoal[]
Min items:
0Max items:
5Example
[ { "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example", "conditions": [ { "type": "example", "url": "example" } ], "prev_goal_id": 0, "flag": "example" } ]Example
{ "steps": [ { "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example", "conditions": [ { "type": "example", "url": "example" } ], "prev_goal_id": 0, "flag": "example" } ] }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"steps": [
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{}
],
"prev_goal_id": 0,
"flag": "example"
}
]
}
DepthGoal
Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
depth
Type: integer
Количество просмотренных пользователем страниц.
Min value:
2Example
{ "depth": 2 }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"depth": 2
}
EmailGoal
Нажатие на email.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
FileGoal
Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
MessengerGoal
Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
PaymentSystemGoal
Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.
All of 1 type
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example"
}
PhoneGoal
Нажатие на номер телефона.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
examplehide_phone_number
Type: boolean
Скрывать номер телефона на десктопах.
Example
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example", "hide_phone_number": true }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example",
"hide_phone_number": true
}
SiteSearchGoal
Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
SocialNetworkGoal
Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
UrlGoal
Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
VisitDurationGoal
Продолжительность визита. Цель будет достигнута при времени визита больше заданного.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "is_favorite": true, "status": "example" } -
Type: object
duration
Type: integer
Продолжительность визита в секундах.
Min value:
1Example
{ "duration": 1 }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"duration": 1
}
FilterE
Список структур с информацией о фильтрах счетчика.
|
Name |
Description |
|
action |
Type: string Тип фильтра:
Example: |
|
attr |
Type: string Тип данных, к которым применяется фильтр:
Example: |
|
status |
Type: string Статус фильтра:
Example: |
|
type |
Type: string Отношение или действие для фильтра:
Example: |
|
end_ip |
Type: string Последний IP-адрес диапазона. Example: |
|
id |
Type: integer Идентификатор фильтра. Укажите данный параметр при изменении фильтра счетчика. |
|
start_ip |
Type: string Первый IP-адрес диапазона. Example: |
|
value |
Type: string Значение фильтра. Example: |
|
with_subdomains |
Type: boolean Фильтровать по поддоменам. |
Example
{
"id": 0,
"attr": "example",
"type": "example",
"value": "example",
"action": "example",
"status": "example",
"start_ip": "example",
"end_ip": "example",
"with_subdomains": true
}
OperationE
Список структур с информацией об операциях счетчика.
|
Name |
Description |
|
action |
Type: string Тип операции:
Example: |
|
attr |
Type: string Поле для фильтрации:
Example: |
|
status |
Type: string Статус операции:
Example: |
|
id |
Type: integer Идентификатор операции (требуется указывать при изменении операции счетчика). |
|
value |
Type: string Значение для замены. Example: |
Example
{
"id": 0,
"action": "example",
"attr": "example",
"value": "example",
"status": "example"
}
CounterGrantE
Список структур с информацией о правах доступа к счетчику.
|
Name |
Description |
|
perm |
Type: string Уровень доступа:
Example: |
|
comment |
Type: string Произвольный комментарий. Количество символов не должно превышать 255. Min length: Max length: Example: |
|
created_at |
Type: string<date-time> Дата предоставления доступа в формате YYYY-MM-DD'T'hh:mm:ssZ. Example: |
|
partner_data_access |
Type: boolean Доступ к группе отчетов «Монетизация». Пользователь сможет просматривать отчеты, добавлять группировки и метрики из группы «Монетизация» в другие отчеты. Если у пользователя есть доступ на редактирование, то ему уже доступны отчеты группы «Монетизация». Возможные значения:
|
|
user_login |
Type: string Логин пользователя, которому выдано разрешение на управление счетчиком. Параметр содержит пустую строку, если к статистике счетчика предоставлен публичный доступ ( Example: |
Example
{
"user_login": "example",
"perm": "example",
"created_at": "2025-01-01T00:00:00Z",
"comment": "example",
"partner_data_access": true
}
AccessFiltersShortE
Список фильтров доступа, к которым выдано разрешение.
|
Name |
Description |
|
id |
Type: integer id фильтра доступа. |
|
name |
Type: string Название фильтра доступа. Example: |
Example
{
"id": 0,
"name": "example"
}
AccessFiltersGrantE
All of 2 types
-
Type: CounterGrantE
Список структур с информацией о правах доступа к счетчику.
Example
{ "user_login": "example", "user_uid": 0, "perm": "example", "created_at": "2025-01-01T00:00:00Z", "comment": "example", "email": "example", "partner_data_access": true } -
Type: object
access_filters
Type: AccessFiltersShortE[]
Min items:
1Max items:
1Example
[ { "id": 0, "name": "example" } ]Example
{ "access_filters": [ { "id": 0, "name": "example" } ] }
Example
{
"user_login": "example",
"user_uid": 0,
"perm": "example",
"created_at": "2025-01-01T00:00:00Z",
"comment": "example",
"email": "example",
"partner_data_access": true,
"access_filters": [
{
"id": 0,
"name": "example"
}
]
}
Label
Метка.
|
Name |
Description |
|
id |
Type: integer Идентификатор метки. |
|
name |
Type: string Имя метки. Min length: Max length: Example: |
Example
{
"id": 0,
"name": "example"
}
WebvisorOptions
Структура с информацией о настройках Вебвизора.
|
Name |
Description |
|
arch_enabled |
Type: boolean Сохранение страниц сайта:
|
|
arch_type |
Type: string Запись содержимого страниц:
Example: |
|
load_player_type |
Type: string Загрузка страниц в плеер:
Example: |
|
urls |
Type: string Список страниц для сохранения. Min length: Max length: Example: |
|
wv_forms |
Type: boolean Запись содержимого полей и форм:
|
|
wv_version |
Type: integer Версия вебвизора. |
Example
{
"urls": "example",
"arch_enabled": true,
"arch_type": "example",
"load_player_type": "example",
"wv_version": 0,
"wv_forms": true
}
InformerOptionsE
Настройки информера.
|
Name |
Description |
|
color_arrow |
Type: integer Цвет стрелки на информере:
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 Цвет текста на информере:
Min value: Max value: |
|
enabled |
Type: boolean Разрешение отображения информера:
|
|
indicator |
Type: string Показатель, который будет отображаться на информере:
Example: |
|
size |
Type: integer Размер информера:
Min value: Max value: |
|
type |
Type: string Тип информера:
Example: |
Example
{
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
}
CodeOptionsE
Настройки кода счетчика.
|
Name |
Description |
|
alternative_cdn |
Type: boolean Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика:
|
|
async |
Type: boolean Асинхронный код счетчика:
|
|
clickmap |
Type: boolean Сбор статистики для работы отчета Карта кликов:
|
|
ecommerce |
Type: boolean Сбор данных по электронной коммерции:
|
|
in_one_line |
Type: boolean Выводить код счетчика в одну строку:
|
|
informer |
Type: InformerOptionsE Настройки информера. Example
|
|
track_hash |
Type: boolean Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов:
|
|
visor |
Type: boolean Запись и анализ поведения посетителей сайта:
|
|
xml_site |
Type: boolean Для XML-сайтов. Элемент noscript не должен использоваться в XML документах:
|
Example
{
"async": true,
"informer": {
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
},
"visor": true,
"track_hash": true,
"xml_site": true,
"clickmap": true,
"in_one_line": true,
"ecommerce": true,
"alternative_cdn": true
}
PublisherOptions
Структура с информацией о настройках контентной аналитики.
|
Name |
Description |
|
enabled |
Type: boolean Сбор данных контентной аналитики. Для начала сбора статистики нужно добавить на сайт разметку.
|
|
schema |
Type: string Доступные варианты разметки сайта. Возможные значения:
Example: |
|
schema_options |
Type: string[] Example
|
Example
{
"enabled": true,
"schema": "example",
"schema_options": [
"example"
]
}
CounterMirrorE
Список зеркал (доменов) сайта.
|
Name |
Description |
|
site |
Type: string Полный домен сайта. Min length: Max length: Example: |
Example
{
"site": "example"
}
CounterCms
CMS система счетчика. Возможные значения поля code:
bitrix24— Битрикс24.flexbe— Flexbe.joomla— Joomla.drupal— Drupal.opencart— OpenCart.tilda— Tilda.webasyst— Webasyst.wix— Wix.wordpress— Wordpress.insales— Insales.nethouse— Nethouse. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
|
Name |
Description |
|
code |
Type: string Example: |
|
custom |
Type: string Min length: Max length: Example: |
Example
{
"code": "example",
"custom": "example"
}
CounterCrm
CRM система счетчика. Возможные значения поля code:
amocrm— AmoCRM.bitrix24— Битрикс24.megaplan— Мегаплан.crm_1c— 1С:CRM.moysklad— Мой склад.yclients— Yclients.retailcrm— RetailCRM. Также можно передать пользовательское значение в поле custom размером не более 128 символов.
|
Name |
Description |
|
code |
Type: string Example: |
|
custom |
Type: string Min length: Max length: Example: |
Example
{
"code": "example",
"custom": "example"
}
SiteActivityProfile
Профиль активности счетчика. Возможные значения поля code:
retail- Интернет-магазин.promo_site- Промо-сайт.online_service- Облачное приложение.text_site- Информационный сайт. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.
|
Name |
Description |
|
code |
Type: string Example: |
|
custom |
Type: string Min length: Max length: Example: |
Example
{
"code": "example",
"custom": "example"
}
CounterFlags
Безопасность и использование данных.
|
Name |
Description |
|
collect_first_party_data |
Type: boolean Использовать дополнительные настройки отслеживания. Опция разрешает Метрике использовать введенные посетителем контактные данные с сайта для улучшения работы рекламных алгоритмов и более точного анализа поведения посетителей сайта. Это поможет вам повышать эффективность рекламных кампаний и узнавать больше о поведении посетителей, даже если они используют браузеры с ограничением межсайтовых cookies (third-party cookies) — например, Safari или Mozilla Firefox. |
|
direct_allow_use_goals_without_access |
Type: boolean Разрешить в рекламных кампаниях оптимизацию по целям без доступа к счетчику. Если управлением ваших рекламных кампаний в Директе занимается кто-то кроме вас, например, агентство или специалист по настройке, вы можете дать разрешение на использование существующих в Метрике целей. Если счетчик создан недавно, опция включена по умолчанию. Подробно см. в Справке. |
|
measurement_enabled |
Type: boolean Включить опцию Measurement Protocol. Measurement Protocol — API для отправки данных о взаимодействиях пользователей напрямую на сервера Метрики через HTTP-запросы. |
|
use_in_benchmarks |
Type: boolean Получать доступ к отчетам по рынку. Опция разрешает Метрике использовать агрегированные обезличенные данные счетчика для построения отчетов по аналитике рынка. Собираемые данные дадут вам возможность понимать состояние своего бизнеса относительно рынка. Если счетчик создан недавно, опция включена по умолчанию. |
Example
{
"use_in_benchmarks": true,
"direct_allow_use_goals_without_access": true,
"collect_first_party_data": true,
"measurement_enabled": true
}
LocationOnPage
|
Name |
Description |
|
path |
Type: string Местоположение на странице Min length: Max length: Example: |
|
type_of_path |
Type: string Тип указанного местоположения Example: |
Example
{
"type_of_path": "example",
"path": "example"
}
CounterEdit
Счетчик.
|
Name |
Description |
|
activity_status |
Type: string Посещаемость счетчика. Возможные значения:
Example: |
|
autogoals_enabled |
Type: boolean Включение автоматических целей. Возможные значения:
|
|
cms |
Type: CounterCms CMS система счетчика. Возможные значения поля code:
Example
|
|
code |
Type: string HTML-код вставки. Example: |
|
code_options |
Type: CodeOptionsE Настройки кода счетчика. Example
|
|
counter_flags |
Type: CounterFlags Безопасность и использование данных. Example
|
|
create_time |
Type: string<date-time> Дата и время создания счетчика. Example: |
|
crm |
Type: CounterCrm CRM система счетчика. Возможные значения поля code:
Example
|
|
delete_time |
Type: string Время удаления счетчика. Example: |
|
favorite |
Type: boolean Добавлен ли счетчик в избранное:
|
|
filter_robots |
Type: integer Фильтрация роботов:
Min value: Max value: |
|
filters |
Type: FilterE[] Example
|
|
filters_remove |
Type: integer Нужно ли удалить фильтры:
|
|
gdpr_agreement_accepted |
Type: boolean Согласие с Договором об обработке данных в сервисе Яндекс Метрика.
|
|
goals |
Type: arrayOne of 13 types
Список структур с информацией о целях счетчика. Example
|
|
goals_remove |
Type: integer Нужно ли удалить цели:
|
|
grants |
Type: arrayOne of 2 types
Example
|
|
grants_remove |
Type: integer Нужно ли удалить настройки доступа:
|
|
id |
Type: integer Идентификатор счетчика. |
|
labels |
Type: Label[] Список структур с информацией о метках. Example
|
|
measurement_tokens |
Type: string[] Example
|
|
mirrors_remove |
Type: integer Нужно ли удалить зеркала:
|
|
mirrors2 |
Type: CounterMirrorE[] Example
|
|
name |
Type: string Наименование счетчика. Min length: Max length: Example: |
|
operations |
Type: OperationE[] Example
|
|
operations_remove |
Type: integer Нужно ли удалить операции:
|
|
owner_login |
Type: string Логин владельца счетчика. Example: |
|
permission |
Type: string Уровень доступа к счетчику:
Example: |
|
publisher_options |
Type: PublisherOptions Структура с информацией о настройках контентной аналитики. Example
|
|
site_activity |
Type: SiteActivityProfile Профиль активности счетчика. Возможные значения поля code:
Example
|
|
site2 |
Type: CounterMirrorE Список зеркал (доменов) сайта. Example
|
|
status |
Type: string Статус счетчика. возможные значения:
Example: |
|
time_zone_name |
Type: string Часовой пояс для расчета статистики. Example: |
|
time_zone_offset |
Type: integer Текущее смещение часового пояса от Гринвича, минуты. |
|
type |
Type: string Тип счетчика. Возможные значения:
Example: |
|
update_time |
Type: string Время последнего изменения счетчика. Example: |
|
vendor_id |
Type: integer |
|
visit_threshold |
Type: integer Таймаут визита в секундах. Default: Min value: Max value: |
|
webvisor |
Type: WebvisorOptions Структура с информацией о настройках Вебвизора. Example
|
Example
{
"id": 0,
"status": "example",
"owner_login": "example",
"activity_status": "example",
"name": "example",
"type": "example",
"favorite": true,
"permission": "example",
"goals": [
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"is_favorite": true,
"status": "example",
"conditions": [
null
],
"prev_goal_id": 0,
"flag": "example"
}
],
"filters": [
{
"id": 0,
"attr": "example",
"type": "example",
"value": "example",
"action": "example",
"status": "example",
"start_ip": "example",
"end_ip": "example",
"with_subdomains": true
}
],
"operations": [
{
"id": 0,
"action": "example",
"attr": "example",
"value": "example",
"status": "example"
}
],
"grants": [
{
"user_login": "example",
"user_uid": 0,
"perm": "example",
"created_at": "2025-01-01T00:00:00Z",
"comment": "example",
"email": "example",
"partner_data_access": true
}
],
"labels": [
{
"id": 0,
"name": "example"
}
],
"webvisor": {
"urls": "example",
"arch_enabled": true,
"arch_type": "example",
"load_player_type": "example",
"wv_version": 0,
"wv_forms": true
},
"code_options": {
"async": true,
"informer": {
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
},
"visor": true,
"track_hash": true,
"xml_site": true,
"clickmap": true,
"in_one_line": true,
"ecommerce": true,
"alternative_cdn": true,
"ecommerce_object": "example",
"ssr": true
},
"create_time": "2025-01-01T00:00:00Z",
"time_zone_name": "example",
"time_zone_offset": 0,
"update_time": "example",
"delete_time": "example",
"code": "example",
"filter_robots": 1,
"visit_threshold": 1800,
"publisher_options": {
"enabled": true,
"schema": "example",
"schema_options": [
"example"
]
},
"vendor_id": 0,
"mirrors_remove": 0,
"goals_remove": 0,
"filters_remove": 0,
"operations_remove": 0,
"grants_remove": 0,
"site2": {
"site": "example",
"domain": "example",
"status": "example"
},
"gdpr_agreement_accepted": true,
"mirrors2": [
null
],
"cms": {
"code": "example",
"custom": "example"
},
"crm": {
"code": "example",
"custom": "example"
},
"site_activity": {
"code": "example",
"custom": "example"
},
"autogoals_enabled": true,
"counter_flags": {
"counter_id": 0,
"use_in_benchmarks": true,
"direct_allow_use_goals_without_access": true,
"incognito": "example",
"collect_first_party_data": true,
"collect_masked_first_party_data": true,
"statistics_over_site": true,
"measurement_enabled": true,
"vendor_data": true,
"allow_use_data_to_collect_feedback": true
},
"measurement_tokens": [
"example"
]
}
CommunicationChannel
Каналы коммуникации счетчика. Возможные значения поля code:
messengers— Мессенджеры.call_track— Call-tracking телефония.direct_call— Прямые звонки. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.
|
Name |
Description |
|
code |
Type: string Example: |
|
custom |
Type: string Min length: Max length: Example: |
Example
{
"code": "example",
"custom": "example"
}
CounterIndustry
Индустрии счетчика. Возможные значения поля code:
finance_and_insurance- Финансы и страхование.real_estate- Недвижимость.construction- Строительство и ремонт.house_and_garden- Дом и сад.domestic_services- Бытовые услуги и общепит.electronics- Электроника.healthcare- Медицина.appliances- Бытовая техника.gastronomy- Кулинария и рецепты.auto_and_moto- Авто и мото.engineering_and_technologies- Техника и технологии.it_and_telecom- IT и Телеком.clothes- Одежда и обувь.health_and_beauty- Здоровье и красота.sport- Спорт и активный образ жизни.jobs_and_career- Работа и карьера.education- Образование.family_and_kids- Семья и дети.pets- Домашние животные.travel- Путешествия и туризм.entertainment- Развлечения, отдых, 18+.social_networks- Общение (соцсети, мессенджеры).gifts- Подарки.business_and_consulting- Бизнес и консалтинг.advertisement- Реклама и маркетинг.online_services- Онлайн-сервисы.industry- Промышленность и сельское хозяйство.transportation- Транспорт и перевозки.legal_services- Юридические услуги и консалтинг.government_and_society- Государство и общество.knowledge_sources- Справочные ресурсы.news- Новости и СМИ.culture_and_art- Культура и искусство.religion- Религия.science- Наука.unexplored- Непознанное. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.
|
Name |
Description |
|
code |
Type: string Example: |
|
custom |
Type: string Min length: Max length: Example: |
Example
{
"code": "example",
"custom": "example"
}
UserActivityProfile
Профили активности пользователя на счетчике. Возможные значения:
business- Управление бизнесом.traffic- Маркетинг и реклама.conversions- Продажи и конверсии.product_management- Управление продуктом.marketing- Контент-маркетинг.design- Дизайн интерфейса.development- Разработка и поддержка.analytics- Аналитика. Также можно передать пользовательское значение в поле custom размером не более 1000 символов.
|
Name |
Description |
|
code |
Type: string Example: |
|
custom |
Type: string Min length: Max length: Example: |
Example
{
"code": "example",
"custom": "example"
}
Responses
200 OK
OK
Body
application/json
{
"counter": {
"id": 0,
"status": "example",
"owner_login": "example",
"activity_status": "example",
"name": "example",
"type": "example",
"favorite": true,
"hide_address": true,
"pro": true,
"pro_features": [
"example"
],
"permission": "example",
"goals": [
null
],
"filters": [
{
"id": 0,
"attr": "example",
"type": "example",
"value": "example",
"action": "example",
"status": "example",
"start_ip": "example",
"end_ip": "example",
"with_subdomains": true
}
],
"operations": [
{
"id": 0,
"action": "example",
"attr": "example",
"value": "example",
"status": "example"
}
],
"grants": [
{
"user_login": "example",
"user_uid": 0,
"perm": "example",
"created_at": "2025-01-01T00:00:00Z",
"comment": "example",
"email": "example",
"partner_data_access": true
}
],
"labels": [
{
"id": 0,
"name": "example"
}
],
"webvisor": {
"urls": "example",
"arch_enabled": true,
"arch_type": "example",
"load_player_type": "example",
"wv_version": 0,
"allow_wv2": true,
"notify_wv2": true,
"wv_forms": true
},
"code_options": {
"async": true,
"informer": {
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
},
"visor": true,
"track_hash": true,
"xml_site": true,
"clickmap": true,
"in_one_line": true,
"ecommerce": true,
"alternative_cdn": true,
"ecommerce_object": "example",
"ytm": true,
"ssr": true
},
"create_time": "2025-01-01T00:00:00Z",
"time_zone_name": "example",
"time_zone_offset": 0,
"partner_id": 0,
"title": "example",
"grants_cnt": 0,
"source": "example",
"update_time": "example",
"delete_time": "example",
"code": "example",
"filter_robots": 1,
"currency": 0,
"currency_code": "example",
"visit_threshold": 1800,
"max_goals": 0,
"max_operations": 0,
"max_filters": 0,
"features": [
"example"
],
"publisher_options": {
"enabled": true,
"schema": "example",
"schema_options": [
"example"
]
},
"total_geo_points_count": 0,
"selected_geo_points_count": 0,
"vendor_id": 0,
"site2": {
"site": "example",
"domain": "example",
"status": "example"
},
"gdpr_agreement_accepted": true,
"delete_guest_allowed": true,
"mirrors2": [
null
],
"cms": {
"code": "example",
"custom": "example"
},
"crm": {
"code": "example",
"custom": "example"
},
"communication_channel": [
{
"code": "example",
"custom": "example"
}
],
"industry": [
{
"code": "example",
"custom": "example"
}
],
"site_activity": {
"code": "example",
"custom": "example"
},
"user_activity": [
{
"code": "example",
"custom": "example"
}
],
"autogoals_enabled": true,
"ecommerce_deduplicator_enabled": true,
"counter_flags": {
"counter_id": 0,
"use_in_benchmarks": true,
"direct_allow_use_goals_without_access": true,
"incognito": "example",
"collect_first_party_data": true,
"collect_masked_first_party_data": true,
"statistics_over_site": true,
"measurement_enabled": true,
"vendor_data": true,
"allow_use_data_to_collect_feedback": true
},
"measurement_tokens": [
"example"
]
}
}
|
Name |
Description |
|
counter |
Type: CounterFull Счетчик. Example
|
GoalE
|
Name |
Description |
|
name |
Type: string Наименование цели. Min length: Max length: Example: |
|
type |
Type: string Тип цели:
Example: |
|
default_price |
Type: number Цена цели по умолчанию. |
|
goal_source |
Type: string Признак того, как создана цель:
Example: |
|
id |
Type: integer Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
|
is_favorite |
Type: boolean Является ли цель избранной:
|
|
status |
Type: string Example: |
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"goal_source": "example",
"is_favorite": true,
"status": "example"
}
ActionGoal
JavaScript-событие.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
ChatGoal
Нажатие на чат.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: array
One of 3 types
-
Type: ChatGoalConditionAnswered
Example
{ "field": "example", "answered": true } -
Type: ChatGoalConditionPlatform
Example
{ "field": "example", "platform": "telegram" } -
Type: ChatGoalConditionTag
Example
{ "field": "example", "operator": "example", "value": "example" }
Example
[ { "field": "example", "answered": true } ]Example
{ "conditions": [ { "field": "example", "answered": true } ] } -
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
null
]
}
ConditionalGoal
Список шагов составной цели.
|
Name |
Description |
|
name |
Type: string Наименование цели. Min length: Max length: Example: |
|
type |
Type: string Тип цели:
Example: |
|
conditions |
Type: GoalCondition[] Example
|
|
default_price |
Type: number Цена цели по умолчанию. |
|
flag |
Type: string Тип цели для клиентов Яндекс Маркета:
Example: |
|
goal_source |
Type: string Признак того, как создана цель:
Example: |
|
id |
Type: integer Идентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика. |
|
is_favorite |
Type: boolean Является ли цель избранной:
|
|
status |
Type: string Example: |
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
CompositeGoal
Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
steps
Type: ConditionalGoal[]
Min items:
0Max items:
5Example
[ { "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example", "conditions": [ { "type": "example", "url": "example" } ], "prev_goal_id": 0, "flag": "example" } ]Example
{ "steps": [ { "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example", "conditions": [ { "type": "example", "url": "example" } ], "prev_goal_id": 0, "flag": "example" } ] }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"steps": [
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{}
],
"prev_goal_id": 0,
"flag": "example"
}
]
}
DepthGoal
Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
depth
Type: integer
Количество просмотренных пользователем страниц.
Min value:
2Example
{ "depth": 2 }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"depth": 2
}
EmailGoal
Нажатие на email.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
FileGoal
Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
MessengerGoal
Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
PaymentSystemGoal
Платежные системы. Цель считается достигнутой, если посетитель совершил оплату через платежную систему.
All of 1 type
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example"
}
PhoneGoal
Нажатие на номер телефона.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
examplehide_phone_number
Type: boolean
Скрывать номер телефона на десктопах.
Example
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example", "hide_phone_number": true }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example",
"hide_phone_number": true
}
SiteSearchGoal
Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
SocialNetworkGoal
Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
UrlGoal
Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
conditions
Type: GoalCondition[]
Example
[ { "type": "example", "url": "example" } ]flag
Type: string
Тип цели для клиентов Яндекс Маркета:
basket— корзина, страница посещения корзины.order— заказ, страница подтверждения заказа.
Example:
exampleExample
{ "conditions": [ { "type": "example", "url": "example" } ], "flag": "example" }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
{
"type": "example",
"url": "example"
}
],
"flag": "example"
}
VisitDurationGoal
Продолжительность визита. Цель будет достигнута при времени визита больше заданного.
All of 2 types
-
Type: GoalE
Example
{ "id": 0, "name": "example", "type": "example", "default_price": 0.5, "is_retargeting": true, "goal_source": "example", "is_favorite": true, "status": "example" } -
Type: object
duration
Type: integer
Продолжительность визита в секундах.
Min value:
1Example
{ "duration": 1 }
Example
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"duration": 1
}
CodeOptionsE
Настройки кода счетчика.
|
Name |
Description |
|
alternative_cdn |
Type: boolean Позволяет корректно учитывать посещения из регионов, в которых ограничен доступ к ресурсам Яндекса. Использование этой опции может снизить скорость загрузки кода счётчика:
|
|
async |
Type: boolean Асинхронный код счетчика:
|
|
clickmap |
Type: boolean Сбор статистики для работы отчета Карта кликов:
|
|
ecommerce |
Type: boolean Сбор данных по электронной коммерции:
|
|
in_one_line |
Type: boolean Выводить код счетчика в одну строку:
|
|
informer |
Type: InformerOptionsE Настройки информера. Example
|
|
track_hash |
Type: boolean Отслеживание хеша в адресной строке браузера. Опция применима для AJAX-сайтов:
|
|
visor |
Type: boolean Запись и анализ поведения посетителей сайта:
|
|
xml_site |
Type: boolean Для XML-сайтов. Элемент noscript не должен использоваться в XML документах:
|
|
ytm |
Type: boolean Использование системы управления тегами. Возможные значения:
|
Example
{
"async": true,
"informer": {
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
},
"visor": true,
"track_hash": true,
"xml_site": true,
"clickmap": true,
"in_one_line": true,
"ecommerce": true,
"alternative_cdn": true,
"ytm": true
}
CounterEdit
Счетчик.
|
Name |
Description |
|
activity_status |
Type: string Посещаемость счетчика. Возможные значения:
Example: |
|
autogoals_enabled |
Type: boolean Включение автоматических целей. Возможные значения:
|
|
cms |
Type: CounterCms CMS система счетчика. Возможные значения поля code:
Example
|
|
code |
Type: string HTML-код вставки. Example: |
|
code_options |
Type: CodeOptionsE Настройки кода счетчика. Example
|
|
counter_flags |
Type: CounterFlags Безопасность и использование данных. Example
|
|
create_time |
Type: string<date-time> Дата и время создания счетчика. Example: |
|
crm |
Type: CounterCrm CRM система счетчика. Возможные значения поля code:
Example
|
|
delete_time |
Type: string Время удаления счетчика. Example: |
|
favorite |
Type: boolean Добавлен ли счетчик в избранное:
|
|
filter_robots |
Type: integer Фильтрация роботов:
Min value: Max value: |
|
filters |
Type: FilterE[] Example
|
|
filters_remove |
Type: integer Нужно ли удалить фильтры:
|
|
gdpr_agreement_accepted |
Type: boolean Согласие с Договором об обработке данных в сервисе Яндекс Метрика.
|
|
goals |
Type: arrayOne of 13 types
Список структур с информацией о целях счетчика. Example
|
|
goals_remove |
Type: integer Нужно ли удалить цели:
|
|
grants |
Type: arrayOne of 2 types
Example
|
|
grants_remove |
Type: integer Нужно ли удалить настройки доступа:
|
|
id |
Type: integer Идентификатор счетчика. |
|
labels |
Type: Label[] Список структур с информацией о метках. Example
|
|
measurement_tokens |
Type: string[] Example
|
|
mirrors_remove |
Type: integer Нужно ли удалить зеркала:
|
|
mirrors2 |
Type: CounterMirrorE[] Example
|
|
name |
Type: string Наименование счетчика. Min length: Max length: Example: |
|
operations |
Type: OperationE[] Example
|
|
operations_remove |
Type: integer Нужно ли удалить операции:
|
|
owner_login |
Type: string Логин владельца счетчика. Example: |
|
permission |
Type: string Уровень доступа к счетчику:
Example: |
|
publisher_options |
Type: PublisherOptions Структура с информацией о настройках контентной аналитики. Example
|
|
site_activity |
Type: SiteActivityProfile Профиль активности счетчика. Возможные значения поля code:
Example
|
|
site2 |
Type: CounterMirrorE Список зеркал (доменов) сайта. Example
|
|
source |
Type: string Тип счетчика. Возможные значения:
Example: |
|
status |
Type: string Статус счетчика. возможные значения:
Example: |
|
time_zone_name |
Type: string Часовой пояс для расчета статистики. Example: |
|
time_zone_offset |
Type: integer Текущее смещение часового пояса от Гринвича, минуты. |
|
type |
Type: string Тип счетчика. Возможные значения:
Example: |
|
update_time |
Type: string Время последнего изменения счетчика. Example: |
|
vendor_id |
Type: integer |
|
visit_threshold |
Type: integer Таймаут визита в секундах. Default: Min value: Max value: |
|
webvisor |
Type: WebvisorOptions Структура с информацией о настройках Вебвизора. Example
|
Example
{
"id": 0,
"status": "example",
"owner_login": "example",
"activity_status": "example",
"name": "example",
"type": "example",
"favorite": true,
"permission": "example",
"goals": [
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
null
],
"prev_goal_id": 0,
"flag": "example"
}
],
"filters": [
{
"id": 0,
"attr": "example",
"type": "example",
"value": "example",
"action": "example",
"status": "example",
"start_ip": "example",
"end_ip": "example",
"with_subdomains": true
}
],
"operations": [
{
"id": 0,
"action": "example",
"attr": "example",
"value": "example",
"status": "example"
}
],
"grants": [
{
"user_login": "example",
"user_uid": 0,
"perm": "example",
"created_at": "2025-01-01T00:00:00Z",
"comment": "example",
"email": "example",
"partner_data_access": true
}
],
"labels": [
{
"id": 0,
"name": "example"
}
],
"webvisor": {
"urls": "example",
"arch_enabled": true,
"arch_type": "example",
"load_player_type": "example",
"wv_version": 0,
"allow_wv2": true,
"notify_wv2": true,
"wv_forms": true
},
"code_options": {
"async": true,
"informer": {
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
},
"visor": true,
"track_hash": true,
"xml_site": true,
"clickmap": true,
"in_one_line": true,
"ecommerce": true,
"alternative_cdn": true,
"ecommerce_object": "example",
"ytm": true,
"ssr": true
},
"create_time": "2025-01-01T00:00:00Z",
"time_zone_name": "example",
"time_zone_offset": 0,
"source": "example",
"update_time": "example",
"delete_time": "example",
"code": "example",
"filter_robots": 1,
"visit_threshold": 1800,
"publisher_options": {
"enabled": true,
"schema": "example",
"schema_options": [
"example"
]
},
"vendor_id": 0,
"mirrors_remove": 0,
"goals_remove": 0,
"filters_remove": 0,
"operations_remove": 0,
"grants_remove": 0,
"site2": {
"site": "example",
"domain": "example",
"status": "example"
},
"gdpr_agreement_accepted": true,
"mirrors2": [
null
],
"cms": {
"code": "example",
"custom": "example"
},
"crm": {
"code": "example",
"custom": "example"
},
"site_activity": {
"code": "example",
"custom": "example"
},
"autogoals_enabled": true,
"counter_flags": {
"counter_id": 0,
"use_in_benchmarks": true,
"direct_allow_use_goals_without_access": true,
"incognito": "example",
"collect_first_party_data": true,
"collect_masked_first_party_data": true,
"statistics_over_site": true,
"measurement_enabled": true,
"vendor_data": true,
"allow_use_data_to_collect_feedback": true
},
"measurement_tokens": [
"example"
]
}
CounterFull
Счетчик.
|
Name |
Description |
|
activity_status |
Type: string Посещаемость счетчика. Возможные значения:
Example: |
|
autogoals_enabled |
Type: boolean Включение автоматических целей. Возможные значения:
|
|
cms |
Type: CounterCms CMS система счетчика. Возможные значения поля code:
Example
|
|
code |
Type: string HTML-код вставки. Example: |
|
code_options |
Type: CodeOptionsE Настройки кода счетчика. Example
|
|
counter_flags |
Type: CounterFlags Безопасность и использование данных. Example
|
|
create_time |
Type: string<date-time> Дата и время создания счетчика. Example: |
|
crm |
Type: CounterCrm CRM система счетчика. Возможные значения поля code:
Example
|
|
delete_time |
Type: string Время удаления счетчика. Example: |
|
favorite |
Type: boolean Добавлен ли счетчик в избранное:
|
|
filter_robots |
Type: integer Фильтрация роботов:
Min value: Max value: |
|
filters |
Type: FilterE[] Example
|
|
gdpr_agreement_accepted |
Type: boolean Согласие с Договором об обработке данных в сервисе Яндекс Метрика.
|
|
goals |
Type: arrayOne of 13 types
Список структур с информацией о целях счетчика. Example
|
|
grants |
Type: arrayOne of 2 types
Example
|
|
id |
Type: integer Идентификатор счетчика. |
|
labels |
Type: Label[] Список структур с информацией о метках. Example
|
|
measurement_tokens |
Type: string[] Example
|
|
mirrors2 |
Type: CounterMirrorE[] Example
|
|
name |
Type: string Наименование счетчика. Min length: Max length: Example: |
|
operations |
Type: OperationE[] Example
|
|
owner_login |
Type: string Логин владельца счетчика. Example: |
|
permission |
Type: string Уровень доступа к счетчику:
Example: |
|
publisher_options |
Type: PublisherOptions Структура с информацией о настройках контентной аналитики. Example
|
|
site_activity |
Type: SiteActivityProfile Профиль активности счетчика. Возможные значения поля code:
Example
|
|
site2 |
Type: CounterMirrorE Список зеркал (доменов) сайта. Example
|
|
source |
Type: string Тип счетчика. Возможные значения:
Example: |
|
status |
Type: string Статус счетчика. возможные значения:
Example: |
|
time_zone_name |
Type: string Часовой пояс для расчета статистики. Example: |
|
time_zone_offset |
Type: integer Текущее смещение часового пояса от Гринвича, минуты. |
|
type |
Type: string Тип счетчика. Возможные значения:
Example: |
|
update_time |
Type: string Время последнего изменения счетчика. Example: |
|
vendor_id |
Type: integer |
|
visit_threshold |
Type: integer Таймаут визита в секундах. Default: Min value: Max value: |
|
webvisor |
Type: WebvisorOptions Структура с информацией о настройках Вебвизора. Example
|
Example
{
"id": 0,
"status": "example",
"owner_login": "example",
"activity_status": "example",
"name": "example",
"type": "example",
"favorite": true,
"permission": "example",
"goals": [
{
"id": 0,
"name": "example",
"type": "example",
"default_price": 0.5,
"is_retargeting": true,
"goal_source": "example",
"is_favorite": true,
"status": "example",
"conditions": [
null
],
"prev_goal_id": 0,
"flag": "example"
}
],
"filters": [
{
"id": 0,
"attr": "example",
"type": "example",
"value": "example",
"action": "example",
"status": "example",
"start_ip": "example",
"end_ip": "example",
"with_subdomains": true
}
],
"operations": [
{
"id": 0,
"action": "example",
"attr": "example",
"value": "example",
"status": "example"
}
],
"grants": [
{
"user_login": "example",
"user_uid": 0,
"perm": "example",
"created_at": "2025-01-01T00:00:00Z",
"comment": "example",
"email": "example",
"partner_data_access": true
}
],
"labels": [
{
"id": 0,
"name": "example"
}
],
"webvisor": {
"urls": "example",
"arch_enabled": true,
"arch_type": "example",
"load_player_type": "example",
"wv_version": 0,
"allow_wv2": true,
"notify_wv2": true,
"wv_forms": true
},
"code_options": {
"async": true,
"informer": {
"enabled": true,
"type": "example",
"size": 1,
"indicator": "example",
"color_start": "FFFFFFFF.",
"color_end": "EFEFEFFF",
"color_text": 0,
"color_arrow": 0
},
"visor": true,
"track_hash": true,
"xml_site": true,
"clickmap": true,
"in_one_line": true,
"ecommerce": true,
"alternative_cdn": true,
"ecommerce_object": "example",
"ytm": true,
"ssr": true
},
"create_time": "2025-01-01T00:00:00Z",
"time_zone_name": "example",
"time_zone_offset": 0,
"source": "example",
"update_time": "example",
"delete_time": "example",
"code": "example",
"filter_robots": 1,
"visit_threshold": 1800,
"publisher_options": {
"enabled": true,
"schema": "example",
"schema_options": [
"example"
]
},
"vendor_id": 0,
"site2": {
"site": "example",
"domain": "example",
"status": "example"
},
"gdpr_agreement_accepted": true,
"mirrors2": [
null
],
"cms": {
"code": "example",
"custom": "example"
},
"crm": {
"code": "example",
"custom": "example"
},
"site_activity": {
"code": "example",
"custom": "example"
},
"autogoals_enabled": true,
"counter_flags": {
"counter_id": 0,
"use_in_benchmarks": true,
"direct_allow_use_goals_without_access": true,
"incognito": "example",
"collect_first_party_data": true,
"collect_masked_first_party_data": true,
"statistics_over_site": true,
"measurement_enabled": true,
"vendor_data": true,
"allow_use_data_to_collect_feedback": true
},
"measurement_tokens": [
"example"
]
}
No longer supported, please use an alternative and newer version.