Выгрузка журнала заявок через API

Модель атрибуции заявок. Возможные значения:

• 0 — последнее взаимодействие;
• 1 — последний непрямой;

По умолчанию, если параметр не указан - заявки выгружаются согласно модели атрибуции, настроенной в ЛК. Более подробно о моделях атрибуции Вы можете узнать в соответствующей статье.

• request — по дате создания заявок (по умолчанию)
• session — по дате сессий

В качестве его значения можно указать телефонный номер, для выгрузки только тех заявок, в которых был указан этот телефонный номер.

Режим фильтрации предыдущего параметра по номеру телефона, оставленного в заявке. Описание режимов смотри ниже.

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

Режим фильтрации предыдущего параметра по электронной почте, оставленной в заявке. Описание режимов смотри ниже.

Флаг выгрузки тегов, которые были присвоены заявкам. 

Формат: 

• true - включить в ответ теги заявок
• false - отсутствие параметра - не включать. По умолчанию false

Флаг выгрузки данных по рекламным кампаниям Яндекс.Директ. Если входной параметр withYandexDirect = true, то в выгрузке присутствует выходной параметр yandexDirect, если withYandexDirect = false или не указан, то выходной параметр yandexDirect отсутствует.

Формат:

• withWidgetInfo=true — выгружать данные
• withWidgetInfo=false или отсутствие параметра — не выгружать данные

Формат:

• withCustomFields=true — выгружать данные
• withCustomFields=false или отсутствие параметра — не выгружать данные

Если параметр не указан - по умолчанию false

Данные будут доступны в выходном параметре customFields.

• true — выгрузить данные по отправке заявки в DCM
• false — не выгружать данные

По каждой заявки может быть несколько отправок в DCM, в соответствии с настройками интеграции. Поэтому в ответе будет массив данных, каждая отправка будет в отдельном элементе массива. В ответ на запрос к API попадает последняя попытка отправки на момент обращения к нашему API.

Комментарии к заявкам. Возможные значения: 

• Если у заявки не будет комментариев, значение параметра будет в виде пустого массива:
  "comments": []
• Если у заявки будут комментарии, значение параметра будет массив комментариев:

Где вложенные объекты элемента массива:

• commentId — ID комментария (число);
• requestId — ID заявки, по которой оставлен комментарий (число);
• comment —- комментарий (строка);
• partyId — ID пользователя, оставившего комментарий (число);
• partyName — логин пользователя, оставившего комментарий (строка).

Обратите внимание, в конце комментария comment может присутствовать символ \n. Он означает перенос строки, не забудьте учесть это при парсинге параметров.

Объект будет содержать вложенные объекты с описанием посещения, за которым закрепилась заявка. Описание вложенных объектов:

• keywords — ключевой запрос;
• city — город посетителя (определяется по его IP-адресу);
• ip — IP-адрес;
• browser — user agent браузера;
• source — Источник перехода;
• medium — Канал перехода;
• ref — адрес страницы, с которой был совершен реферальный переход на Ваш отслеживаемый сайт (присутствует только если переход посетителя был реферальным);
• url — адрес входа на сайт (может отличаться от страницы, с которой в итоге была отправлена заявка);
• utmSource — значение utm-метки utm_source;
• utmMedium — значение utm-метки utm_medium;
• utmTerm — значение utm-метки utm_term;
• utmContent — значение utm-метки utm_content;
• utmCampaign — значение utm-метки utm_campaign;
• device — тип устройства;
• os — название операционной системы;
• browserName — название браузера;
• guaClientId — идентификатор Google Client ID (присутствует, если настроена интеграция с Google Analytics);
• yaClientId — идентификатор Yandex Client ID (присутствует, если настроена интеграция с Яндекс.Метрика);
• ctGlobalId — глобальный идентификатор посетителя Calltouch, общий для сайтов, на которых установлен скрипт Calltouch;
• sessionId — идентификатор сессии Calltouch, который Вы отправили в запросе ранее;
• attribution — текущая модель атрибуции, согласно которой определился источник заявки (модель атрибуции может быть изменена в системных настройках ЛК, после этого источники будут "на лету" переопределены у всех звонков и заявок ранее);
• attrs — Сторонние параметры, переданные заранее в статистику Calltouch.

Если Вы не отправляли идентификатор сессии Calltouch в запросе, объект будет равен значению null.

• true (уникально-целевая заявка);
• false (не уникально-целевая заявка).

• true (уникальная заявка);
• false (повторная заявка).

Объект будет содержать вложенные объекты с описанием клиента, данные по которому Вы отправили в запросе. Описание вложенных объектов:

• fio — имя клиента;
• clientId — идентификатор клиента внутри Calltouch;
• phones — содержит массив, внутри которого в объекте phoneNumber содержится номер телефона клиента;
• contacts — содержит массив, внутри которого в объекте contactValue содержится почта клиента.

Целевая заявка. Может принимать следующие значения:

• true (целевая заявка);
• false (не целевая заявка).

Массив всех сделок, связанных с заявкой. Для каждой сделки будет содержать вложенные объекты с описанием сделки, связанной с заявкой, если таковые были созданы (см. статью Управление сделками через API). Описание вложенных объектов:

• orderId — идентификатор сделки внутри Calltouch;
• dateCreated — дата и время создания сделки;
• status — cтатус сделки;
• sum — бюджет сделки;
• orderNumber — уникальный идентификатор сделки в Вашей CRM (если при создании сделки Вы не отправляли данный параметр, в ответе будет содержаться уникальный идентификатор сделки в Calltouch - он же будет и в объекте orderId выше).

Если Вы не отправляли идентификатор сессии Calltouch в запросе, массив будет пустой.

История посещений. Параметр присутствует в случае, если указан входной параметр истории посещений withMapVisits=true. Результат будет содержать все посещения пользователя оставившего заявку на сайте,

• utmSource
• sessionDate
• sessionID
• city
• ip
• utmTerm
• utmContent
• userAgent
• sessionId
• source
• medium
• utmCampaign
• url
• ref
• additionalTags
• utmMedium
• guaClientId
• keyword
• ctClientId
• ctGlobalId

Если источник звонка или заявки рекламная кампания Яндекс.Директ, между Calltouch и Яндекс.Директ включена интеграция, то в данном параметре выводится следующая информация:

• campaignId — ID кампании;
• adGroupId — ID группы;
• adId — ID объявления;
• criteriaId —ID фразы
  Пример ответа, когда у звонка или заявки есть эти данные:

"yandexDirect": {
 "campaignId": 32515134,
 "adGroupId": 325245212134,
 "adId": 2546356252,
 "criteriaId": 254251323
}

Пример ответа, когда у звонка или заявки нет этих данных (не настроена интеграция, либо данные еще не собрались):

"yandexDirect": null

• campaignId — ID кампании;
• adGroupId — ID группы;
• creativeId — ID объявления;
• criteriaId — ID фразы
  Пример ответа, когда у звонка или заявки есть эти данные:

"googleAdWords": {
 "campaignId": 35635656,
 "adGroupId": 134524245,
 "creativeId": 23134141,
 "criteriaId": 4324553542
}

Пример ответа, когда у звонка или заявки нет этих данных (не настроена интеграция, либо данные еще не собрались):

"googleAdWords": null

Данные по отправке заявки с DoubleClick Campaign Manager.

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

1. Если входной параметр withDcm (см. выше) не задан или false, то:

"dcm": null

"dcm": []

"dcm": [
 {
  "profileIdDCM": 1411789,
  "floodlightConfigurationId": "10355394",
  "floodlightActivityId": "10501143",
  "requestStatus": "ERROR",
  "requestErrors": "HTTP_AUTH_ERROR"
 }
]

Где:

• profileIdDCM — идентификатор профиля DCM;
• floodlightConfigurationId — конфигурация из DCM;
• floodlightActivityId — идентификатор флудлайта;
• requestStatus — статус отправки заявки в DCM. Возможные значения:
  • success — успешная отправка;
  • error — отправка, завершенная ошибкой;
• requestErrors — описание ошибки отправки заявки в DCM, если она возникает. Если нет, то значение будет null.

Данные по кастомным полям заявки из виджета. Выгружаются только для заявок через виджеты, если был передан входной параметр withWidgetInfo=true

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

[
    {
        ...
       "widgetInfo" : {
         "fields": [
             {"name":"Имя", "value": "Иван" },
             { "name": "Номер телефона", "value": "+7 (977) 684-11-08", "type": "phone", "title": null },
          ]
        }
      ...
   }
] 		

Данные по пользовательским полям в звонках. Будут в ответе если был передан входной параметр withCustomFields=true.

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

[
    {
        ...
       "customFields": [
            {"field": "name", "value": "Вася"},
            {"field": "birthday", "value": "1990-01-01"}
        ]
        ...
    }] 	

Идентификатор посетителя Calltouch. Он представляет из себя значение нашей куки _ct. Если в звонке значение отсутствует (у лида нет сессии, например, звонок на статический номер), то в значении будет null.

Теги заявок, присутствуют в случае, если указан входной параметр withRequestTags=true. 

Параметр содержит следующие данные: 

• category (категория тега, по умолчанию равна имени тега);

• names (имя тега) 

category — устаревший параметр, оставлен в API для обратной совместимости и в ЛК нигде не используется.

Теги нужно парсить из RequestTags[i].names. Если там встречается запятая – это разделить тегов и их там несколько.