Описание типа goal

Тип для описания цели

Внимание.

Передача авторизационного токена в параметрах URL перестанет работать 13 февраля 2019 года. Чтобы продолжить работу с API Метрики, настройте авторизацию по токену в HTTP-заголовке.

23 января, 30 января и 6 февраля 2019 года запланировано профилактическое отключение устаревшего способа авторизации — в эти дни он будет временно отключен.

Формат ответа

Action цель


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "is_retargeting" :  < boolean > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
ПараметрыОписание
idИдентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.
nameНаименование цели.
typeТип цели.

Возможные значения

  • number — просмотр N страниц;
  • action — цель типа событие.
  • step — составная цель;
  • url — совпадение по URL страницы;
is_retargetingЯвляется ли цель ретаргетинговой.

Возможные значения

  • 0 ― не является (по умолчанию);
  • 1 ― является.
flagТип цели для клиентов Яндекс.Маркета.

Возможные значения

  • basket — «корзина», страница посещения корзины;
  • order — «заказ», страница подтверждения заказа.
conditionsCписок структур с условиями цели.
ПараметрыОписание
typeТип условия.

Возможные значения

  • regexp — удовлетворяет регулярному выражению;
  • contain — содержит;
  • start — начинается с;
  • exact — совпадает;
  • action — специальный тип условия для целей типа action.
urlАдрес страницы или части страницы для условия.

Формат ответа

Составная цель.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "is_retargeting" :  < boolean > ,
    "steps" : [ {
        "id" :  < int > ,
        "name" :  < string > ,
        "type" :  < goal_type > ,
        "is_retargeting" :  < boolean > ,
        "flag" :  < goal_market_type > ,
        "conditions" : [ {
            "type" :  < goal_condition_type > ,
            "url" :  < string > 
        }, ... ]
    }, ... ]
}
ПараметрыОписание
idИдентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.
nameНаименование цели.
typeТип цели.

Возможные значения

  • number — просмотр N страниц;
  • action — цель типа событие.
  • step — составная цель;
  • url — совпадение по URL страницы;
is_retargetingЯвляется ли цель ретаргетинговой.

Возможные значения

  • 0 ― не является (по умолчанию);
  • 1 ― является.
stepsСписок шагов составной цели.
ПараметрыОписание
idИдентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.
nameНаименование цели.
typeТип цели.

Возможные значения

  • number — просмотр N страниц;
  • action — цель типа событие.
  • step — составная цель;
  • url — совпадение по URL страницы;
is_retargetingЯвляется ли цель ретаргетинговой.

Возможные значения

  • 0 ― не является (по умолчанию);
  • 1 ― является.
flagТип цели для клиентов Яндекс.Маркета.

Возможные значения

  • basket — «корзина», страница посещения корзины;
  • order — «заказ», страница подтверждения заказа.
conditionsCписок структур с условиями цели.
ПараметрыОписание
typeТип условия.

Возможные значения

  • regexp — удовлетворяет регулярному выражению;
  • contain — содержит;
  • start — начинается с;
  • exact — совпадает;
  • action — специальный тип условия для целей типа action.
urlАдрес страницы или части страницы для условия.

Формат ответа

Цель типа depth.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "is_retargeting" :  < boolean > ,
    "depth" :  < long > 
}
ПараметрыОписание
idИдентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.
nameНаименование цели.
typeТип цели.

Возможные значения

  • number — просмотр N страниц;
  • action — цель типа событие.
  • step — составная цель;
  • url — совпадение по URL страницы;
is_retargetingЯвляется ли цель ретаргетинговой.

Возможные значения

  • 0 ― не является (по умолчанию);
  • 1 ― является.
depthКоличество просмотренных пользователем страниц.

Формат ответа

Урловая цель.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "is_retargeting" :  < boolean > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
ПараметрыОписание
idИдентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.
nameНаименование цели.
typeТип цели.

Возможные значения

  • number — просмотр N страниц;
  • action — цель типа событие.
  • step — составная цель;
  • url — совпадение по URL страницы;
is_retargetingЯвляется ли цель ретаргетинговой.

Возможные значения

  • 0 ― не является (по умолчанию);
  • 1 ― является.
flagТип цели для клиентов Яндекс.Маркета.

Возможные значения

  • basket — «корзина», страница посещения корзины;
  • order — «заказ», страница подтверждения заказа.
conditionsCписок структур с условиями цели.
ПараметрыОписание
typeТип условия.

Возможные значения

  • regexp — удовлетворяет регулярному выражению;
  • contain — содержит;
  • start — начинается с;
  • exact — совпадает;
  • action — специальный тип условия для целей типа action.
urlАдрес страницы или части страницы для условия.

Формат ответа

Цель типа offline.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "is_retargeting" :  < boolean > 
}
ПараметрыОписание
idИдентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.
nameНаименование цели.
typeТип цели.

Возможные значения

  • number — просмотр N страниц;
  • action — цель типа событие.
  • step — составная цель;
  • url — совпадение по URL страницы;
is_retargetingЯвляется ли цель ретаргетинговой.

Возможные значения

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

Формат ответа

Цель типа звонок.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "is_retargeting" :  < boolean > 
}
ПараметрыОписание
idИдентификатор цели. Укажите данный параметр при изменении и удалении цели счетчика.
nameНаименование цели.
typeТип цели.

Возможные значения

  • number — просмотр N страниц;
  • action — цель типа событие.
  • step — составная цель;
  • url — совпадение по URL страницы;
is_retargetingЯвляется ли цель ретаргетинговой.

Возможные значения

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