Создать трейс сквозной аналитики crm.tracking.trace.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод:

  • любой пользователь может создать трейс
  • пользователь с правом на изменение объекта может привязать трейс

Метод 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 нужного типа объекта.

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

Примеры кода

Как использовать примеры в документации

Пример создания трейса сквозной аналитики, где:

  • TRACE — JSON-строка с UTM-меткой utm_source и значением yandex-maps
  • ENTITIES — контакт и лид, которые связываются с трейсом
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"
        
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
              }
            ],
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/crm.tracking.trace.add.json"
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'crm.tracking.trace.add',
            params: {
              TRACE: '{"tags":{"list":{"utm_source":"yandex-maps"}}}',
              ENTITIES: [
                {
                  TYPE: 'CONTACT',
                  ID: 17,
                },
                {
                  TYPE: 'LEAD',
                  ID: 1000739,
                },
              ],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Created trace ID:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addTrackingTrace() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.tracking.trace.add',
                params: {
                  TRACE: '{"tags":{"list":{"utm_source":"yandex-maps"}}}',
                  ENTITIES: [
                    {
                      TYPE: 'CONTACT',
                      ID: 17,
                    },
                    {
                      TYPE: 'LEAD',
                      ID: 1000739,
                    },
                  ],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Created trace ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addTrackingTrace)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.tracking.trace.add',
                    [
                        'TRACE' => '{"tags":{"list":{"utm_source":"yandex-maps"}}}',
                        'ENTITIES' => [
                            [
                                'TYPE' => 'CONTACT',
                                'ID' => 17,
                            ],
                            [
                                'TYPE' => 'LEAD',
                                'ID' => 1000739,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding trace: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.tracking.trace.add',
            {
                TRACE: '{"tags":{"list":{"utm_source":"yandex-maps"}}}',
                ENTITIES: [
                    {
                        TYPE: 'CONTACT',
                        ID: 17
                    },
                    {
                        TYPE: 'LEAD',
                        ID: 1000739
                    }
                ]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        

Пример

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.tracking.trace.add(
                trace="{\"tags\":{\"list\":{\"utm_source\":\"yandex-maps\"}}}",
                entities=[
                    {
                        "TYPE": "CONTACT",
                        "ID": 17
                    },
                    {
                        "TYPE": "LEAD",
                        "ID": 1000739
                    }
                ],
            )
            result = bitrix_response.response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Ошибка Bitrix API",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Ошибка Bitrix SDK: {error.message}")
        except Exception as error:
            print(f"Непредвиденная ошибка: {error}")
        
$result = CRest::call(
            'crm.tracking.trace.add',
            [
                'TRACE' => '{"tags":{"list":{"utm_source":"yandex-maps"}}}',
                'ENTITIES' => [
                    [
                        'TYPE' => 'CONTACT',
                        'ID' => 17,
                    ],
                    [
                        'TYPE' => 'LEAD',
                        'ID' => 1000739,
                    ],
                ],
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "crm.tracking.trace.add", b24.Params{
            "TRACE": "{\"tags\":{\"list\":{\"utm_source\":\"yandex-maps\"}}}",
        	"ENTITIES": []b24.Params{
        		{
        			"TYPE": "CONTACT",
                    "ID":   17,
        		},
        		{
        			"TYPE": "LEAD",
                    "ID":   1000739,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.tracking.trace.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("разбор ответа: %w", err)
        }
        fmt.Println("идентификатор:", newID)
        

Обработка ответа

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."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус

Код

Описание

Значение

400

ERROR_CORE

Parameter TRACE required.

Не передан параметр TRACE

400

ERROR_CORE

Can not parse JSON in parameter TRACE.

Значение TRACE не является корректной JSON-строкой

400

ERROR_CORE

Wrong TYPE in parameter ENTITIES. Allowed types: COMPANY,CONTACT,DEAL,LEAD,QUOTE

Передан недопустимый TYPE в ENTITIES

400

ERROR_CORE

Wrong ID in parameter ENTITIES.

Передан некорректный ID в ENTITIES

400

ERROR_CORE

You have no access to entity <TYPE> with ID <ID>.

Нет прав на изменение объекта, указанного в ENTITIES

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение