Документация для разработчиков

Как передать информацию в Сквозную аналитику

При создании сущностей через REST есть 3 способа передать информацию для сквозной аналитики.

Самый простой

Передать в полях создаваемой сущности поле UTM_SOURCE.

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

Полные данные

Передать в полях создаваемой сущности поле TRACE.

В этом случае будут учтены все данные - устройство, все каналы (в том числе и сайт), посещенные страницы.

Способ работает для методов: crm.lead.add, crm.deal.add, crm.contact.add, crm.company.add, crm.quote.add

{
   "fields": {
      "NAME": "test",
      "LAST_NAME": "",
      "TRACE": ...
  },
}

Значение М поля TRACE должен быть или идентификатор сохраненной записи сквозной аналитики или JSON-строка с массивом определенного формата, для получения которого можно просто воспользоваться JS-кодом виджета сквозной аналитики Битрикс24:

//js
b24Tracker.guest.getTrace()

Значение поля TRACE может быть число - ID трейса, который получен rest-методом crm.tracking.trace.add.

Создание трейса и получение его ID

Метод создает трейс:

crm.tracking.trace.add
?ENTITIES[0][TYPE]=CONTACT&ENTITIES[0][ID]=3215&ENTITIES[1][TYPE]=LEAD&ENTITIES[1][ID]=1&TRACE=

Поле TRACE обязательное, значение - Строка, полученная методом b24Tracker.guest.getTrace, пример выше.

Поле ENTITIES не обязательное, в нем можно перечислить сущности, которые связываются с этим трейсом:

ENTITIES: [{TYPE: 'CONTACT', ID: 1}, {TYPE: 'LEAD', ID: 101}]

Один трейс для связанных сущностей

Если создаётся пакет связанных сущностей (сделка + контакт + компания), то можно создать единый трейс для них. Если контакт и компания существующие, а создается только сделка, то можно создать трейс и привязать к существующим сущностям.

Смотри так же



Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх