Методы в процессе раскатки — выходят в обновлении crm 26.2100.0. Доступны не на всех порталах Битрикс24. Пока метод не доступен, API вернёт 422 METHOD_NOT_YET_AVAILABLE.

Источники и каналы сквозной аналитики

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

Битрикс24 API: crm.tracking.source.*, crm.tracking.channel.list Скоуп: crm

Для работы нужны флаг crm-tracking-v3 и включённая возможность сквозной аналитики REST v3 на портале Битрикс24. Чтение разрешено ключу READONLY, запись требует READWRITE.

Операции

• POST /v1/crm-tracking/sources — создать источник

• GET /v1/crm-tracking/sources — список источников

• GET /v1/crm-tracking/sources/:id — получить источник

• GET /v1/crm-tracking/sources/by-code/:code — получить встроенный источник

• PATCH /v1/crm-tracking/sources/:id — изменить источник

• PATCH /v1/crm-tracking/sources/by-code/:code — изменить встроенный источник

• POST /v1/crm-tracking/sources/:id/archive — архивировать

• POST /v1/crm-tracking/sources/by-code/:code/archive — архивировать по коду

• POST /v1/crm-tracking/sources/:id/unarchive — вернуть из архива

• POST /v1/crm-tracking/sources/by-code/:code/unarchive — вернуть по коду

• GET /v1/crm-tracking/channels — список каналов

• GET /v1/crm-tracking/sources/:id/expenses — список ручных расходов

• POST /v1/crm-tracking/sources/:id/expenses — добавить ручные расходы

• DELETE /v1/crm-tracking/expenses/:id — удалить ручные расходы

• GET /v1/crm-tracking/analytics/sources — отчёт по источникам

• GET /v1/crm-tracking/sources/:id/ad-account/authorization — Получить ссылку авторизации

• GET /v1/crm-tracking/sources/:id/ad-accounts — Список рекламных кабинетов

• POST /v1/crm-tracking/sources/:id/ad-account — Подключить рекламный кабинет

• DELETE /v1/crm-tracking/sources/:id/ad-account — Отключить рекламный кабинет

• GET /v1/crm-tracking/sources/:id/ad-tree — Читать дерево рекламы

• POST /v1/crm-tracking/sources/:id/ad-expenses — Выполнить шаг отчёта о расходах

• GET /v1/crm-tracking/sources/:id/ad-expenses — Прочитать прогресс отчёта

Ключевые поля

Поле	Описание
Полеid	ОписаниеИдентификатор записи из списка источников. null у ненастроенного встроенного источника.
Полеcode	ОписаниеКод встроенного источника из списка источников, например google. У своего источника — null.
Полеkind	ОписаниеbuiltIn — встроенный, own — свой.
ПолеisActive	ОписаниеПризнак активности. Архивные записи читаются с archived=true.
ПолеrefDomains, utmSources	ОписаниеДомены переходов и значения UTM-источника. Запись заменяет переданный список целиком.

Что нужно знать перед работой

1. Источник адресуется ровно одним значением: числовым id или строковым code в пути. Второй адрес в запросе не принимается.
2. Первое изменение встроенного источника по коду создаёт запись. Отсутствующий идентификатор не означает отсутствие самого встроенного источника.
3. По умолчанию список содержит активные и ненастроенные встроенные источники. archived=true выбирает архивные записи.
4. Создание возвращает data.id, изменение — перечитанный источник. Архивирование и возврат идемпотентны и отвечают 204 без тела. Трейсы и расходы сохраняются.
5. Ограничения на изменение встроенных источников и права проверяет Битрикс24. Названия и коды в ответах — данные портала.

Типичный сценарий

1. Прочитать источники и каналы.
2. Создать источник с названием и значениями UTM-источника.
3. Изменить источник, передав только изменяемые поля.
4. Отправить источник в архив и при необходимости вернуть.

Лимиты

Ограничение	Значение
ОграничениеРазмер страницы	Значениеlimit: от 1 до 500, по умолчанию 50.
ОграничениеСмещение	Значениеoffset: неотрицательное целое, по умолчанию 0. Один запрос читает одну страницу.
ОграничениеСписки доменов и UTM-источников	ЗначениеДо 100 значений в каждом, проверяет Битрикс24.
ОграничениеИмя и отдельное значение списка	ЗначениеДо 255 символов, проверяет Битрикс24.
ОграничениеФильтр источников	ЗначениеТолько archived=true или false. Сортировка не задаётся.
ОграничениеКаналы	ЗначениеБез фильтра и сортировки, с limit и offset.

Смотрите также

• Трейсы сквозной аналитики
• Авторизация
• Ошибки