Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-tracking/ad-expenses-start.md индекс документации — /llms.txt
Метод появляется в обновлении
crm 26.2100.0и пока доступен не на всех порталах Битрикс24. Если метод ещё не включён, API возвращает422 METHOD_NOT_YET_AVAILABLE.
Выполнить шаг построения отчёта о рекламных расходах
POST /v1/crm-tracking/sources/:id/ad-expenses
Запустить или продолжить построение отчёта о рекламных расходах за выбранный период. Один запрос выполняет один шаг.
Нужны скоуп crm, включённый флаг crm-tracking-v3 и доступность метода на портале Битрикс24. Ключ READONLY не может выполнять этот запрос.
Параметры
| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
Параметрid (path) |
Типinteger | Обяз.да | По умолч.— | ОписаниеПоложительный ID источника из списка источников. |
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
ПолеdateFrom |
Типstring | Обяз.да | ОписаниеНачало периода, YYYY-MM-DD. |
ПолеdateTo |
Типstring | Обяз.да | ОписаниеКонец периода, YYYY-MM-DD. |
Примеры
curl — личный ключ
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"dateFrom":"2026-10-01","dateTo":"2026-10-07"}'
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"dateFrom":"2026-10-01","dateTo":"2026-10-07"}'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ dateFrom: '2026-10-01', dateTo: '2026-10-07' }),
})
const result = await res.json()
console.log(result)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/42/ad-expenses', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({ dateFrom: '2026-10-01', dateTo: '2026-10-07' }),
})
const result = await res.json()
console.log(result)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue |
Полеdata |
Типobject | ОписаниеПрогресс отчёта. |
Полеdata.complete |
Типboolean | ОписаниеЗавершено ли построение отчёта. |
Полеdata.label |
Типstring или null | ОписаниеТекст текущего шага или null. Язык зависит от портала. |
Пример ответа
{
"success": true,
"data": {
"complete": false,
"label": null
}
}
Пример ответа при ошибке
400 — источник не поддерживает рекламные отчёты:
{
"success": false,
"error": {
"code": "CRM_TRACKING_AD_PROVIDER_UNSUPPORTED",
"message": "CRM_TRACKING_AD_PROVIDER_UNSUPPORTED"
}
}
Ошибки
| 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. |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч READONLY не может строить отчёт. |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа не настроен доступ к Битрикс24. |
| HTTP422 | КодMETHOD_NOT_YET_AVAILABLE |
ОписаниеФлаг выключен или метод ещё не включён на портале. error.release — crm 26.2100.0. |
| HTTP502 | КодBITRIX_UNAVAILABLE |
ОписаниеБитрикс24 вернул ответ неверной структуры. |
Другие коды отказов, статусы и сообщения Битрикс24 сохраняются. Общие ошибки API — Ошибки.
Известные особенности
Если complete равно false, выполните следующий шаг повторным POST с тем же периодом. Одного чтения прогресса недостаточно, чтобы продолжить построение отчёта.