Создать трейс сквозной аналитики crm.tracking.trace.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод:
- любой пользователь может создать трейс
- пользователь с правом на изменение объекта может привязать трейс
Метод crm.tracking.trace.add создает трейс сквозной аналитики и возвращает его идентификатор.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
TRACE* |
JSON-строка с данными трейса. Для получения корректного значения смотрите туториал |
|
ENTITIES |
Массив объектов, которые нужно связать с трейсом подробнее |
Параметр ENTITIES
|
Название |
Описание |
|
TYPE* |
Тип объекта. Возможные значения:
|
|
ID* |
Идентификатор элемента. Для указанного объекта у пользователя должны быть права на изменение |
Примеры кода
Как использовать примеры в документации
Пример создания трейса сквозной аналитики, где:
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"
// 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: '{"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,
},
],
},
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: '{"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,
},
],
},
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' => '{"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());
}
}
);
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.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 = 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' => '{"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 |
Идентификатор созданного трейса |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_CORE",
"error_description": "Parameter `TRACE` required."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Parameter |
Не передан параметр |
|
|
|
Can not parse JSON in parameter |
Значение |
|
|
|
Wrong TYPE in parameter |
Передан недопустимый |
|
|
|
Wrong ID in parameter |
Передан некорректный |
|
|
|
You have no access to entity |
Нет прав на изменение объекта, указанного в |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |