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

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: crm

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

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

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

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

TRACE*
string

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

Для получения корректного значения смотрите туториал

ENTITIES
object[]

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

Параметр ENTITIES

Название
тип

Описание

TYPE*
string

Тип объекта. Возможные значения:

  • COMPANY
  • CONTACT
  • DEAL
  • LEAD
  • QUOTE

ID*
integer

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

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

Примеры кода

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

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

  • TRACE — JSON-строка с данными трейса
  • ENTITIES — объекты, которые связываются с трейсом
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "TRACE": "{\"SOURCE_ID\":\"6\",\"SOURCE_DESC\":\"Direct sale\",\"PAGES\":[{\"URL\":\"https://example.com/\",\"DATE\":\"2024-04-03T10:26:32+03:00\"}]}",
            "ENTITIES": [
              {
                "TYPE": "CONTACT",
                "ID": 3215
              },
              {
                "TYPE": "LEAD",
                "ID": 1
              }
            ]
          }' \
          "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": "{\"SOURCE_ID\":\"6\",\"SOURCE_DESC\":\"Direct sale\",\"PAGES\":[{\"URL\":\"https://example.com/\",\"DATE\":\"2024-04-03T10:26:32+03:00\"}]}",
            "ENTITIES": [
              {
                "TYPE": "CONTACT",
                "ID": 3215
              },
              {
                "TYPE": "LEAD",
                "ID": 1
              }
            ],
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/crm.tracking.trace.add.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.tracking.trace.add',
        		{
        			TRACE: '{"SOURCE_ID":"6","SOURCE_DESC":"Direct sale","PAGES":[{"URL":"https://example.com/","DATE":"2024-04-03T10:26:32+03:00"}]}',
        			ENTITIES: [
        				{
        					TYPE: 'CONTACT',
        					ID: 3215
        				},
        				{
        					TYPE: 'LEAD',
        					ID: 1
        				}
        			]
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.tracking.trace.add',
                    [
                        'TRACE' => '{"SOURCE_ID":"6","SOURCE_DESC":"Direct sale","PAGES":[{"URL":"https://example.com/","DATE":"2024-04-03T10:26:32+03:00"}]}',
                        'ENTITIES' => [
                            [
                                'TYPE' => 'CONTACT',
                                'ID' => 3215,
                            ],
                            [
                                'TYPE' => 'LEAD',
                                'ID' => 1,
                            ],
                        ],
                    ]
                );
        
            $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: '{"SOURCE_ID":"6","SOURCE_DESC":"Direct sale","PAGES":[{"URL":"https://example.com/","DATE":"2024-04-03T10:26:32+03:00"}]}',
                ENTITIES: [
                    {
                        TYPE: 'CONTACT',
                        ID: 3215
                    },
                    {
                        TYPE: 'LEAD',
                        ID: 1
                    }
                ]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
$result = CRest::call(
            'crm.tracking.trace.add',
            [
                'TRACE' => '{"SOURCE_ID":"6","SOURCE_DESC":"Direct sale","PAGES":[{"URL":"https://example.com/","DATE":"2024-04-03T10:26:32+03:00"}]}',
                'ENTITIES' => [
                    [
                        'TYPE' => 'CONTACT',
                        'ID' => 3215,
                    ],
                    [
                        'TYPE' => 'LEAD',
                        'ID' => 1,
                    ],
                ],
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

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

HTTP-статус: 200

{
            "result": 341,
            "time": {
                "start": 1775117366,
                "finish": 1775117367.080829,
                "duration": 1.0808289051055908,
                "processing": 0,
                "date_start": "2026-04-02T11:09:26+03:00",
                "date_finish": "2026-04-02T11:09:27+03:00",
                "operating_reset_at": 1775117967,
                "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

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

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

Предыдущая
Обзор методов
Следующая
Удалить трейс сквозной аналитики