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

Аналитика по источникам

GET /v1/crm-tracking/analytics/sources

Получает показатели сквозной аналитики выбранных источников за указанный период.

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

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

Параметры

Параметр Тип Обяз. По умолч. Описание
ПараметрsourceIds (query) Типstring Обяз.да По умолч.— ОписаниеПоложительные целочисленные ID через запятую, например 2,3. Источник ID — список источников.
ПараметрdateFrom (query) Типstring Обяз.да По умолч.— ОписаниеНачало периода, YYYY-MM-DD.
ПараметрdateTo (query) Типstring Обяз.да По умолч.— ОписаниеКонец периода, YYYY-MM-DD.
Параметрlimit (query) Типnumber Обяз.нет По умолч.50 ОписаниеРазмер страницы, целое число от 1 до 500.
Параметрoffset (query) Типnumber Обяз.нет По умолч.0 ОписаниеЧисло пропускаемых записей, неотрицательное целое число.

Пагинация: один запрос возвращает одну страницу без автоматического получения следующих страниц. Для следующей страницы увеличьте offset на limit. Сортировка, дополнительные фильтры и выбор полей не поддерживаются.

Допускается не более 100 уникальных источников. Ограничение количества источников и допустимость периода проверяет Битрикс24.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/analytics/sources?sourceIds=2,3&dateFrom=2026-10-01&dateTo=2026-10-07&limit=50&offset=0" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/analytics/sources?sourceIds=2,3&dateFrom=2026-10-01&dateTo=2026-10-07&limit=50&offset=0" \
  -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/analytics/sources?sourceIds=2,3&dateFrom=2026-10-01&dateTo=2026-10-07&limit=50&offset=0', {
  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/analytics/sources?sourceIds=2,3&dateFrom=2026-10-01&dateTo=2026-10-07&limit=50&offset=0', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()
console.log(result)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue
Полеdata Типarray ОписаниеПоказатели источников.
Полеdata[].sourceId Типnumber ОписаниеID источника из списка источников.
Полеdata[].dateFrom Типstring ОписаниеНачало периода, YYYY-MM-DD.
Полеdata[].dateTo Типstring ОписаниеКонец периода, YYYY-MM-DD.
Полеdata[].currencyId Типstring ОписаниеКод учётной валюты Битрикс24.
Полеdata[].stages Типarray ОписаниеПоказатели по этапам.
Полеdata[].stages[].code Типstring ОписаниеКод этапа.
Полеdata[].stages[].quantity Типnumber ОписаниеКоличество на этапе.
Полеdata[].stages[].sum Типnumber ОписаниеСумма на этапе в валюте currencyId.
Полеdata[].stages[].views Типnumber ОписаниеКоличество просмотров.
Полеdata[].cost Типnumber ОписаниеРасходы в валюте currencyId.
Полеdata[].income Типnumber ОписаниеДоход в валюте currencyId.
Полеdata[].roi Типnumber ОписаниеРентабельность инвестиций в процентах.
Полеmeta.limit Типnumber ОписаниеРазмер запрошенной страницы.
Полеmeta.offset Типnumber ОписаниеЧисло пропускаемых записей.

Общее количество записей в ответе не передаётся.

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

Пример структуры ответа.

JSON 
{
  "success": true,
  "data": [
    {
      "sourceId": 2,
      "dateFrom": "2026-10-01",
      "dateTo": "2026-10-07",
      "currencyId": "USD",
      "stages": [
        {
          "code": "actions",
          "quantity": 1,
          "sum": 12.5,
          "views": 2
        }
      ],
      "cost": 12.5,
      "income": 0,
      "roi": -100
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0
  }
}

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

400 — не передан список источников:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "sourceIds is required"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодMISSING_REQUIRED_FIELDS ОписаниеНе передан sourceIds, dateFrom или dateTo. Пустой sourceIds также считается отсутствующим.
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный список ID, формат дат или параметры пагинации.
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеПередан неизвестный параметр, фильтр, сортировка или выбор полей.
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 — Ошибки.

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

Показатели, денежные значения и учётная валюта передаются из Битрикс24 без пересчёта. API не вычисляет рентабельность повторно. Текстовые значения очищаются от секретных данных.

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