Get Aggregate Statistics imopenlines.v2.Stat.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: imopenlines

Who can execute the method: a user with access to Open Channels reports

The method imopenlines.v2.Stat.get retrieves aggregate Open Channels statistics for a period.

Method Parameters

Required parameters are marked with *

Name
type

Description

dateFrom*
string

Start of the period in ISO 8601 format

dateTo*
string

End of the period in ISO 8601 format.

Maximum period: 366 days

configId
integer

Open channel ID.

You can obtain the ID using imopenlines.config.list.get

configIdList
integer[]

List of open channel IDs.

You can obtain the IDs using imopenlines.config.list.get.

If both configIdList and configId are passed, configIdList is used.

Maximum: 1000 items

source
string

Channel code.

You can obtain the code using imconnector.list

sourceList
string[]

List of channel codes.

You can obtain the codes using imconnector.list.

If both sourceList and source are passed, sourceList is used.

Maximum: 1000 items

operatorId
integer

Operator ID.

You can obtain the ID using user.get or user.search

operatorIdList
integer[]

List of operator IDs.

You can obtain the IDs using user.get or user.search.

If both operatorIdList and operatorId are passed, operatorIdList is used.

Maximum: 1000 items

If you do not pass line, channel, or operator filters, the method calculates statistics for the lines available to the user.

If there is no data for the period, numeric metrics are returned as 0, not null.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "dateFrom": "2026-06-01T00:00:00+02:00",
            "dateTo": "2026-06-30T23:59:59+02:00",
            "configId": 3
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.v2.Stat.get
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "dateFrom": "2026-06-01T00:00:00+02:00",
            "dateTo": "2026-06-30T23:59:59+02:00",
            "configId": 3,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imopenlines.v2.Stat.get
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type StatResult = {
          totalSessions: number
          closedSessions: number
          spamSessions: number
          avgWaitAnswer: number
          avgSessionDuration: number
          likeCount: number
          dislikeCount: number
          votedSessions: number
          positiveRate: number
          kpiFirstAnswerOk: number
          kpiFirstAnswerFail: number
          sessionsBySource: Array<{ source: string, count: number }>
          sessionsByHour: number[]
          sessionsByOperator: Array<{ operatorId: number, count: number, avgWaitAnswer: number, positiveRate: number }>
        }
        
        try {
          const response = await $b24.actions.v2.call.make<StatResult>({
            method: 'imopenlines.v2.Stat.get',
            params: {
              dateFrom: '2026-06-01T00:00:00+02:00',
              dateTo: '2026-06-30T23:59:59+02:00',
              configId: 3,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            console.info(response.getData()!.result)
          }
        } catch (error) {
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getOpenlinesStat() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
              const response = await $b24.actions.v2.call.make({
                method: 'imopenlines.v2.Stat.get',
                params: {
                  dateFrom: '2026-06-01T00:00:00+02:00',
                  dateTo: '2026-06-30T23:59:59+02:00',
                  configId: 3,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              console.info(response.getData().result)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getOpenlinesStat)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.call(
                "imopenlines.v2.Stat.get",
                {
                    "dateFrom": "2026-06-01T00:00:00+02:00",
                    "dateTo": "2026-06-30T23:59:59+02:00",
                    "configId": 3,
                },
            ).response
            print(bitrix_response.result)
        except BitrixAPIError as error:
            print(f"error: {error.error}", f"error_description: {error.error_description}", sep="\n")
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.v2.Stat.get',
                    [
                        'dateFrom' => '2026-06-01T00:00:00+02:00',
                        'dateTo' => '2026-06-30T23:59:59+02:00',
                        'configId' => 3,
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'imopenlines.v2.Stat.get',
            {
                dateFrom: '2026-06-01T00:00:00+02:00',
                dateTo: '2026-06-30T23:59:59+02:00',
                configId: 3,
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.v2.Stat.get',
            [
                'dateFrom' => '2026-06-01T00:00:00+02:00',
                'dateTo' => '2026-06-30T23:59:59+02:00',
                'configId' => 3,
            ]
        );
        
        print_r($result);
        
res, err := client.Core().Call(ctx, "imopenlines.v2.Stat.get", b24.Params{
        	"dateFrom": "2026-06-01T00:00:00+02:00",
        	"dateTo":   "2026-06-30T23:59:59+02:00",
        	"configId": 3,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("imopenlines.v2.Stat.get: %w", err)
        }
        
        fmt.Println(string(res.Result))
        

Response Handling

HTTP Status: 200

{
            "result": {
                "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
                    }
                ],
                "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
                    }
                ]
            },
            "time": {
                "start": 1782810000,
                "finish": 1782810000.3,
                "duration": 0.3,
                "processing": 0,
                "date_start": "2026-06-30T10:00:00+02:00",
                "date_finish": "2026-06-30T10:00:00+02:00",
                "operating_reset_at": 1782810600,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
statResult

Aggregate statistics for the period.

See all fields of the statResult type in Open Channels Statistics Data Types

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "PERIOD_REQUIRED",
            "error_description": "dateFrom and dateTo are required"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status

Code

Description

Value

400

TARIFF_RESTRICTION

Statistics reports are not available on the current tariff plan

The plan does not allow using Open Channels reports

400

PERIOD_REQUIRED

dateFrom and dateTo are required

The dateFrom or dateTo parameter is not provided

400

INVALID_FILTER

Invalid filter value

An invalid filter, date, or list with more than 1000 items was passed

400

PERIOD_TOO_LARGE

The requested period exceeds the maximum of 1 year

The period is longer than 366 days

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning