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

Метрики по сессиям

⚠️ Метод выходит в обновлении imopenlines 26.700.0 и доступен пока не на всех порталах Битрикс24. Если обновление на ваш портал ещё не пришло, API вернёт 422 METHOD_NOT_YET_AVAILABLE — это признак того, что метод на портале ещё не выпущен, а не ошибка интеграции.

POST /v1/openlines/sessions/stats

Пакетные метрики по конкретным сессиям — время ответа и закрытия, счётчики сообщений, число переводов, оценка. До 100 идентификаторов за один вызов.

Поля запроса (body)

Поле Тип Обяз. Описание
sessionId number[] да Массив идентификаторов сессий, до 100 элементов. Источник: POST /v1/openlines/sessions/search. Одиночное число тоже принимается и оборачивается в массив

Дубликаты в sessionId схлопываются: каждый уникальный идентификатор возвращается один раз. Несуществующий, чужой или недоступный sessionId не приводит к ошибке — для него возвращается объект с самим sessionId и null во всех метриках.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/sessions/stats" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "sessionId": [1024, 1025, 999999] }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/sessions/stats" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "sessionId": [1024, 1025, 999999] }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/sessions/stats', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ sessionId: [1024, 1025, 999999] }),
})
const { data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/sessions/stats', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ sessionId: [1024, 1025, 999999] }),
})
const { data } = await res.json()

Поля ответа

Ответ — { "success": true, "data": { "sessions": [...] } }. По одному объекту на каждый уникальный запрошенный sessionId, в том числе недоступные (с null-полями).

Ключ Описание
sessionId Идентификатор сессии
waitAnswer / waitClose Время до первого ответа и до закрытия, секунды
messagesCount Число сообщений в сессии
messagesOperatorCount / messagesClientCount Сообщения оператора и клиента
transfersCount Число переназначений
kpiFirstAnswer Уложились ли в SLA первого ответа
vote Клиентская оценка
voteHead Оценка руководителя (null, если нет права)

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

Третья сессия недоступна или не существует — отдана объектом с null-полями:

JSON 
{
  "success": true,
  "data": {
    "sessions": [
      { "sessionId": 1024, "waitAnswer": 65, "waitClose": 1330, "messagesCount": 14, "messagesOperatorCount": 6, "messagesClientCount": 8, "transfersCount": 1, "kpiFirstAnswer": true, "vote": "like", "voteHead": 5 },
      { "sessionId": 1025, "waitAnswer": 12, "waitClose": 340, "messagesCount": 5, "messagesOperatorCount": 2, "messagesClientCount": 3, "transfersCount": 0, "kpiFirstAnswer": true, "vote": "none", "voteHead": null },
      { "sessionId": 999999, "waitAnswer": null, "waitClose": null, "messagesCount": null, "messagesOperatorCount": null, "messagesClientCount": null, "transfersCount": null, "kpiFirstAnswer": null, "vote": null, "voteHead": null }
    ]
  }
}

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

400 — в батче больше 100 идентификаторов:

JSON 
{
  "success": false,
  "error": { "code": "BATCH_LIMIT_EXCEEDED", "message": "sessionId batch must not exceed 100 unique ids" }
}

Ошибки

HTTP Код Когда
403 B24_TARIFF_RESTRICTION Тариф не включает статистику Открытых линий (report_open_lines)
400 MISSING_PARAMS sessionId пустой массив или не передан
400 INVALID_PARAMS Нечисловой элемент в sessionId
400 BATCH_LIMIT_EXCEEDED Больше 100 уникальных идентификаторов (после схлопывания дублей)
422 METHOD_NOT_YET_AVAILABLE Обновление imopenlines 26.700.0 ещё не приехало на портал

Полный список системных кодов — Ошибки API.

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