For AI agents: markdown of this page — /docs-content-en/openlines/stats.md documentation index — /llms.txt

Channel aggregates for a period

The method ships in the imopenlines 26.700.0 update and is not yet available on all Bitrix24 accounts. If the update has not reached your Bitrix24 account yet, the API returns 422 METHOD_NOT_YET_AVAILABLE — this means the method has not been released on the account yet, not that the integration is broken.

POST /v1/openlines/stats

Summary metrics of Open Channels for a period — session counters, average times, CSAT, and breakdowns by connector, hour, and operator. The main method for top-level dashboard widgets. The method is heavy: request it no more than once every 30–60 seconds and cache the result.

Request fields (body)

Field Type Req. Description
dateFrom string yes Period start, ISO 8601. The dateFrom..dateTo period must not exceed 1 year
dateTo string yes Period end, ISO 8601
configId number no Channel identifier. Source: GET /v1/openline-configs
configIdList number[] no List of channel identifiers
source string no Connector code, for example livechat
sourceList string[] no List of connector codes
operatorId number no Operator identifier. Source: GET /v1/users
operatorIdList number[] no List of operator identifiers

If none of configId*/source*/operatorId* is set, aggregates are computed over all channels available to the current user.

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/openlines/stats" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "dateFrom": "2026-06-01T00:00:00+00:00",
    "dateTo": "2026-06-30T23:59:59+00:00",
    "configId": 3
  }'

curl — OAuth application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/openlines/stats" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dateFrom": "2026-06-01T00:00:00+00:00",
    "dateTo": "2026-06-30T23:59:59+00:00",
    "configId": 3
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/openlines/stats', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dateFrom: '2026-06-01T00:00:00+00:00',
    dateTo: '2026-06-30T23:59:59+00:00',
    configId: 3,
  }),
})
const { data } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/openlines/stats', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dateFrom: '2026-06-01T00:00:00+00:00',
    dateTo: '2026-06-30T23:59:59+00:00',
    configId: 3,
  }),
})
const { data } = await res.json()

Response fields

The response is { "success": true, "data": {...} }. When there is no data for the period, all numeric metrics are returned as 0 (or 0.0), never as null.

Key Description
totalSessions / closedSessions / spamSessions Session counters for the period
avgWaitAnswer / avgSessionDuration Average values, seconds
likeCount / dislikeCount / votedSessions / positiveRate CSAT: the customer rating is a like or a dislike; positiveRate is the share of likes
kpiFirstAnswerOk / kpiFirstAnswerFail Counters for the first-answer SLA
sessionsBySource Breakdown by connector, [{ source, count }]
sessionsByHour Exactly 24 entries (hours 0–23, in the server time zone of the Bitrix24 account)
sessionsByOperator Breakdown by operator, [{ operatorId, count, avgWaitAnswer, positiveRate }]

Response example

JSON 
{
  "success": true,
  "data": {
    "totalSessions": 340,
    "closedSessions": 318,
    "spamSessions": 4,
    "avgWaitAnswer": 42.7,
    "avgSessionDuration": 612.3,
    "likeCount": 210,
    "dislikeCount": 15,
    "votedSessions": 225,
    "positiveRate": 0.9333,
    "kpiFirstAnswerOk": 300,
    "kpiFirstAnswerFail": 18,
    "sessionsBySource": [
      { "source": "livechat", "count": 200 },
      { "source": "whatsapp", "count": 140 }
    ],
    "sessionsByHour": [0,0,0,0,0,0,2,10,25,40,38,30,28,22,20,25,30,20,15,10,8,5,3,1],
    "sessionsByOperator": [
      { "operatorId": 42, "count": 120, "avgWaitAnswer": 38.1, "positiveRate": 0.95 },
      { "operatorId": 51, "count": 90, "avgWaitAnswer": 51.4, "positiveRate": 0.88 }
    ]
  }
}

Error response example

400 — the period is missing:

JSON 
{
  "success": false,
  "error": { "code": "MISSING_PARAMS", "message": "Required: dateFrom, dateTo (ISO 8601 strings)" }
}

Errors

HTTP Code When
403 B24_TARIFF_RESTRICTION The Bitrix24 plan does not include Open Channels statistics (report_open_lines)
400 INVALID_JSON_BODY The request body did not parse as JSON. The check runs before field validation, so the response says nothing about missing parameters
400 MISSING_PARAMS dateFrom and/or dateTo are missing
422 BITRIX_ERROR (error.b24Code: PERIOD_REQUIRED) Bitrix24 did not recognize the period
422 BITRIX_ERROR (error.b24Code: INVALID_FILTER) An invalid filter value or date format
422 BITRIX_ERROR (error.b24Code: PERIOD_TOO_LARGE) The period exceeds 1 year
422 METHOD_NOT_YET_AVAILABLE The imopenlines 26.700.0 update has not reached the portal yet. The response contains an error.release field set to imopenlines 26.700.0

The full list of system codes — API errors.

See also