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

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

Получить прогресс отчёта о рекламных расходах

GET /v1/crm-tracking/sources/:id/ad-expenses

Прочитать текущий прогресс отчёта о рекламных расходах за выбранный период. Запрос не выполняет следующий шаг построения.

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

Параметры

Параметр Тип Обяз. По умолч. Описание
Параметрid (path) Типinteger Обяз.да По умолч.— ОписаниеПоложительный ID источника из списка источников.
ПараметрdateFrom (query) Типstring Обяз.да По умолч.— ОписаниеНачало периода, YYYY-MM-DD.
ПараметрdateTo (query) Типstring Обяз.да По умолч.— ОписаниеКонец периода, YYYY-MM-DD.

Примеры

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

Terminal
curl --get "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses" \
  -H "X-Api-Key: YOUR_API_KEY" \
  --data-urlencode "dateFrom=2026-10-01" \
  --data-urlencode "dateTo=2026-10-07"

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

Terminal
curl --get "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  --data-urlencode "dateFrom=2026-10-01" \
  --data-urlencode "dateTo=2026-10-07"

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

javascript
const query = new URLSearchParams({ dateFrom: '2026-10-01', dateTo: '2026-10-07' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses?${query}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const result = await res.json()
console.log(result)

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

javascript
const query = new URLSearchParams({ dateFrom: '2026-10-01', dateTo: '2026-10-07' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses?${query}`, {
  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.complete Типboolean ОписаниеЗавершено ли построение отчёта.
Полеdata.label Типstring или null ОписаниеТекст текущего шага или null. Язык зависит от портала.

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

JSON
{
  "success": true,
  "data": {
    "complete": false,
    "label": "Получение данных за период 1 October - 7 October"
  }
}

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

404 — источник не найден:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `0` не найдена"
  }
}

Ошибки

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

Другие коды отказов, статусы и сообщения Битрикс24 сохраняются. Общие ошибки API — Ошибки.

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

Если complete равно false, выполните следующий шаг повторным POST с тем же периодом. Одного чтения прогресса недостаточно, чтобы продолжить построение отчёта.

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