Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-tracking/sources-get.md индекс документации — /llms.txt

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

Получить источник сквозной аналитики

GET /v1/crm-tracking/sources/by-code/:code

Читает источник сквозной аналитики по его числовому идентификатору или коду встроенного источника.

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

Параметры

Используйте ровно один вариант адреса: GET /v1/crm-tracking/sources/:id или GET /v1/crm-tracking/sources/by-code/:code. Параметры запроса не принимаются.

Параметр Тип Описание
Параметрid (path) Типnumber ОписаниеПоложительный целый ID источника из списка. Для числового пути.
Параметрcode (path) Типstring ОписаниеНепустой код встроенного источника из списка, например google. Для пути by-code.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/by-code/google" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/by-code/google" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/by-code/google', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const result = await res.json()
console.log(result)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/by-code/google', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()
console.log(result)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue
Полеdata Типobject ОписаниеИсточник.
Полеdata.id Типnumber or null ОписаниеID источника. null у встроенного источника без сохранённой настройки.
Полеdata.code Типstring or null ОписаниеКод встроенного источника. У собственного источника — null.
Полеdata.kind Типstring Описаниеown — собственный, builtIn — встроенный.
Полеdata.name Типstring ОписаниеНазвание источника.
Полеdata.color Типstring or null ОписаниеЦвет источника.
Полеdata.isActive Типboolean ОписаниеИсточник активен.
Полеdata.isConfigurable Типboolean ОписаниеИсточник допускает настройку.
Полеdata.isConfigured Типboolean ОписаниеНастройки источника сохранены.
Полеdata.refDomains Типstring[] ОписаниеДомены переходов.
Полеdata.utmSources Типstring[] ОписаниеЗначения метки utm_source.

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": null,
    "code": "google",
    "kind": "builtIn",
    "name": "Google Ads",
    "color": "#3889db",
    "isActive": true,
    "isConfigurable": true,
    "isConfigured": false,
    "refDomains": [],
    "utmSources": []
  }
}

Пример ответа при ошибке

400 — неподдерживаемый параметр запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Source address belongs in exactly one path parameter"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный ID или пустой код в адресе.
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеПередан параметр запроса, включая второй адрес источника.
HTTP404 КодENTITY_NOT_FOUND ОписаниеИсточник не найден.
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm.
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеФлаг выключен или метод ещё не включён на портале. error.release — crm 26.2100.0.
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеНекорректный ответ Битрикс24.

Коды, HTTP-статусы и тексты остальных отказов Битрикс24 сохраняются. Полный список общих ошибок API — Ошибки.

Известные особенности

Первое изменение встроенного источника по code создаёт сохранённую запись. До этого источник доступен по коду и может иметь id: null.

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