Список целей

Возвращает информацию о целях счетчика.

Request

GET

https://api-metrika.yandex.net/management/v1/counter/{counterId}/goals

Path parameters

Name

Description

counterId*

Type: integer<int32>

Идентификатор счетчика, список целей которого вы хотите получить.
Example: 2215573

Query parameters

Name

Description

callback

Type: string

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

useDeleted

Type: boolean

Информация об удаленных целях.

Default: false

Responses

200 OK

OK

Body

application/json
{
    "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
        }
    ]
}

Name

Description

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)[]

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

ActionGoal

JavaScript-событие.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

CompositeGoal

Составная цель. Нужна для группировки и задания порядка обычных целей. В качестве шагов может содержать цели типа "Посещение страниц" и "JavaScript-событие". Шаг считается достигнутым, если были достигнуты все предыдущие шаги, и после этого были выполнены все условия текущего шага.

Name

Description

name*

Type: string

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

Min length: 0

Max length: 255

steps*

Type: ConditionalGoal[]

Список шагов составной цели.

Min items: 0

Max items: 5

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 ― является.

status

Type: string

DepthGoal

Количество просмотров. Цель считается достигнутой, если посетитель просмотрел заданное количество страниц сайта.

Name

Description

depth*

Type: integer<int64>

Количество просмотренных пользователем страниц.

Min value: 2

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 ― является.

status

Type: string

EmailGoal

Нажатие на email.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

FileGoal

Скачивание файлов. Цель считается достигнутой, если посетитель скачал любой файл или определенный файл.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

MessengerGoal

Переход в мессенджер. Цель будет достигнута при клике пользователем на ссылку, которая ведет в мессенджер.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

PaymentSystemGoal

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

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 ― является.

status

Type: string

PhoneGoal

Нажатие на номер телефона.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

hide_phone_number

Type: boolean

Скрывать номер телефона на десктопах.

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

SiteSearchGoal

Поиск по сайту. Цель будет достигнута при поиске на сайте, если в урле в get-параметрах есть хотя бы одно совпадение.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

SocialNetworkGoal

Переход в социальную сеть. Цель будет достигнута при клике пользователем на ссылку, которая ведет в социальную сеть.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

UrlGoal

Посещение страниц. Достигается, когда выполняется хотя бы одно из условий.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

VisitDurationGoal

Продолжительность визита. Цель будет достигнута при времени визита больше заданного.

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>

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

duration

Type: integer<int32>

Продолжительность визита в секундах.

Min value: 1

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

GoalCondition

Список структур с условиями цели.

Name

Description

type*

Type: string

Тип условия:

  • contain — содержит;
  • exact — совпадает;
  • start — начинается с;
  • regexp — удовлетворяет регулярному выражению;
  • action — специальный тип условия для целей «JavaScript-событие»;
  • messenger — специальный тип условия для целей типа form, путь в dom дереве;
  • all_files — признак для целей «Переход в мессенджер»;
  • file — скачивание конкретного файла для целей «Скачивание файлов»;
  • search — признак для целей «Поиск по сайту»;
  • all_social — специальный тип условия для целей типа social (все социальные сети);
  • social — специальный тип условия для целей типа social (конкретная социальная сеть);
  • regexp_action — js-событие удовлетворяет регулярному выражению (используется только в шаге составной цели);
  • contain_action — js-событие содержит (используется только в шаге составной цели).

url

Type: string

Значение зависит от типа цели:

  • Посещение страниц. Адрес страницы или части страницы для условия.
  • Клик по email или Клик по номеру телефона. Email или номер телефона, который указан в ссылках на сайте. Подробнее о том, как отследить клик по email или номеру телефона.
  • Переход в мессенджер. Название мессенджера, полученное с помощью метода GET management/v1/messengers, или значение all_messengers.
  • Поиск по сайту. GET-параметр, который используется для поиска на сайте. Метрика автоматически распознает параметры q, text, query или search. Если на сайте используется другой параметр, укажите его в запросе.
  • Скачивание файлов. Имя файла, например example.pdf. Значение может быть пустым, если нужно отслеживать скачивание всех файлов на сайте.
  • Переход в социальную сеть. Название социальной сети, полученное с помощью метода GET management/v1/social_networks, или значение all_social.

ConditionalGoal

Список шагов составной цели.

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 — продолжительность визита.

conditions

Type: GoalCondition[]

Список структур с условиями цели.

default_price

Type: number<double>

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

flag

Type: string

Тип цели для клиентов Яндекс Маркета:

  • basket — корзина, страница посещения корзины.
  • order — заказ, страница подтверждения заказа.

goal_source

Type: string

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

id

Type: integer<int64>

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

is_favorite

Type: boolean

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

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

status

Type: string

No longer supported, please use an alternative and newer version.

Предыдущая
Удаление цели
Следующая
Создание цели