Для 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

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

Поля запроса (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 Код Когда
HTTP403 КодB24_TARIFF_RESTRICTION КогдаТариф не включает статистику Открытых линий (report_open_lines)
HTTP400 КодINVALID_JSON_BODY КогдаТело запроса не разобралось как JSON. JSON разбирается до проверки полей, поэтому про отсутствующие параметры ответ ничего не говорит
HTTP400 КодMISSING_PARAMS КогдаsessionId пустой массив или не передан
HTTP400 КодINVALID_PARAMS КогдаНечисловой элемент в sessionId
HTTP400 КодBATCH_LIMIT_EXCEEDED КогдаБольше 100 уникальных идентификаторов (повторы считаются один раз)
HTTP422 КодMETHOD_NOT_YET_AVAILABLE КогдаОбновление imopenlines 26.700.0 ещё не пришло на портал. Ответ содержит поле error.release со значением imopenlines 26.700.0

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

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