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

`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 — [список источников](/docs/entities/crm-tracking/sources-list). |
| `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 — личный ключ

```bash
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-приложение

```bash
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 источника из [списка источников](/docs/entities/crm-tracking/sources-list). |
| `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 | Код | Описание |
|---|---|---|
| 400 | `MISSING_REQUIRED_FIELDS` | Не передан `sourceIds`, `dateFrom` или `dateTo`. Пустой `sourceIds` также считается отсутствующим. |
| 400 | `INVALID_PARAMS` | Некорректный список ID, формат дат или параметры пагинации. |
| 400 | `UNKNOWN_FILTER_FIELD` | Передан неизвестный параметр, фильтр, сортировка или выбор полей. |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `crm`. |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Флаг выключен или метод ещё не включён на портале. `error.release` — `crm 26.2100.0`. |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 вернул некорректную структуру списка. |

Коды, HTTP-статусы и тексты остальных отказов Битрикс24 сохраняются с удалением секретных значений из текста. Полный список общих ошибок API — [Ошибки](/docs/errors).

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

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

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

- [Список источников сквозной аналитики](/docs/entities/crm-tracking/sources-list)
- [Список расходов источника сквозной аналитики](/docs/entities/crm-tracking/expenses-list)