метод REST scope: crm

crm.tracking.trace.add

Создать трейс сквозной аналитики

Кто может выполнять: любой пользователь может создать трейс

Описание

Метод crm.tracking.trace.add создает трейс сквозной аналитики и возвращает его идентификатор.

Параметры

TRACE string необязательный

JSON-строка с данными трейса.

Готовое значение можно получить на сайте через b24Tracker.guest.getTrace(). Практический сценарий описан в туториале.

Если формируете TRACE вручную, передайте UTM-метки в объекте tags.list:

{"tags":{"list":{"utm_source":"yandex-maps"}}}

В этом примере в трейс передается только одна UTM-метка: utm_source со значением yandex-maps. Чтобы передать другие UTM-метки, добавьте их в tags.list, например utm_medium, utm_campaign, utm_content или utm_term

ENTITIES object[] необязательный

Массив объектов, которые нужно связать с трейсом (подробное описание)

Если не передать ENTITIES, метод создаст трейс без привязки к объектам CRM

Параметр ENTITIES

TYPE string необязательный

Тип объекта CRM.

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

  • COMPANY — компания, entityTypeId = 4
  • CONTACT — контакт, entityTypeId = 3
  • DEAL — сделка, entityTypeId = 2
  • LEAD — лид, entityTypeId = 1
  • QUOTE — коммерческое предложение, entityTypeId = 7
ID integer необязательный

Идентификатор элемента CRM.

Идентификатор можно получить методом crm.item.list с entityTypeId нужного типа объекта.

Для указанного объекта у пользователя должны быть права на изменение

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "TRACE": "{\"tags\":{\"list\":{\"utm_source\":\"yandex-maps\"}}}",
    "ENTITIES": [
      {
        "TYPE": "CONTACT",
        "ID": 17
      },
      {
        "TYPE": "LEAD",
        "ID": 1000739
      }
    ]
  }' \
  "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/crm.tracking.trace.add.json"

Ответ

HTTP-статус: 200

{
    "result": 1581,
    "time": {
        "start": 1786711683,
        "finish": 1786711683.296598,
        "duration": 0.296597957611084,
        "processing": 0,
        "date_start": "2026-08-14T15:48:03+03:00",
        "date_finish": "2026-08-14T15:48:03+03:00",
        "operating_reset_at": 1786712283,
        "operating": 0
    }
}

Возвращаемые данные

result integer

Идентификатор созданного трейса

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_CORE",
    "error_description": "Parameter `TRACE` required."
}
Код Описание Значение
400 ERROR_CORE Parameter TRACE required.
400 ERROR_CORE Can not parse JSON in parameter TRACE.
400 ERROR_CORE Wrong TYPE in parameter ENTITIES. Allowed types: COMPANY,CONTACT,DEAL,LEAD,QUOTE
400 ERROR_CORE Wrong ID in parameter ENTITIES.
400 ERROR_CORE You have no access to entity <TYPE> with ID <ID>.

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.