Get Ratings imopenlines.v2.Session.Rating.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
imopenlinesWho can execute the method: a user with access to Open Channels reports
The method imopenlines.v2.Session.Rating.list retrieves sessions rated by customers.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
dateVoteFrom* |
Start of the customer rating period in ISO 8601 format |
|
dateVoteTo* |
End of the customer rating period in ISO 8601 format. Maximum period: 366 days |
|
configId |
Open channel ID. You can obtain the ID using imopenlines.config.list.get |
|
configIdList |
List of open channel IDs. You can obtain the IDs using imopenlines.config.list.get. If both Maximum: 1000 items |
|
operatorId |
Operator ID. You can obtain the ID using user.get or user.search |
|
operatorIdList |
List of operator IDs. You can obtain the IDs using user.get or user.search. If both Maximum: 1000 items |
|
source |
Channel code. You can obtain the code using imconnector.list |
|
sourceList |
List of channel codes. You can obtain the codes using imconnector.list. If both Maximum: 1000 items |
|
vote |
Customer rating. Possible values:
|
|
hasVoteHead |
Filter by supervisor rating availability. Possible values:
|
|
offset |
Pagination offset. Default: |
|
limit |
Page size. Possible values: from Default: |
The method returns only sessions with a customer rating.
Sessions with vote: none are not included in the response.
The voteHead and commentHead fields in rating items are returned as null if the plan or user permissions do not allow viewing supervisor ratings.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"configId": 3,
"vote": "like",
"dateVoteFrom": "2026-06-01T00:00:00+02:00",
"dateVoteTo": "2026-06-30T23:59:59+02:00"
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.v2.Session.Rating.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"configId": 3,
"vote": "like",
"dateVoteFrom": "2026-06-01T00:00:00+02:00",
"dateVoteTo": "2026-06-30T23:59:59+02:00",
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/imopenlines.v2.Session.Rating.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make({
method: 'imopenlines.v2.Session.Rating.list',
params: {
configId: 3,
vote: 'like',
dateVoteFrom: '2026-06-01T00:00:00+02:00',
dateVoteTo: '2026-06-30T23:59:59+02:00',
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
console.info(response.getData()!.result.ratings)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getOpenlinesRatings() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imopenlines.v2.Session.Rating.list',
params: {
configId: 3,
vote: 'like',
dateVoteFrom: '2026-06-01T00:00:00+02:00',
dateVoteTo: '2026-06-30T23:59:59+02:00',
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
console.info(response.getData().result.ratings)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getOpenlinesRatings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.call(
"imopenlines.v2.Session.Rating.list",
{
"configId": 3,
"vote": "like",
"dateVoteFrom": "2026-06-01T00:00:00+02:00",
"dateVoteTo": "2026-06-30T23:59:59+02:00",
},
).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.Session.Rating.list',
[
'configId' => 3,
'vote' => 'like',
'dateVoteFrom' => '2026-06-01T00:00:00+02:00',
'dateVoteTo' => '2026-06-30T23:59:59+02:00',
]
);
print_r($response->getResponseData()->getResult());
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'imopenlines.v2.Session.Rating.list',
{
configId: 3,
vote: 'like',
dateVoteFrom: '2026-06-01T00:00:00+02:00',
dateVoteTo: '2026-06-30T23:59:59+02:00',
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imopenlines.v2.Session.Rating.list',
[
'configId' => 3,
'vote' => 'like',
'dateVoteFrom' => '2026-06-01T00:00:00+02:00',
'dateVoteTo' => '2026-06-30T23:59:59+02:00',
]
);
print_r($result);
res, err := client.Core().Call(ctx, "imopenlines.v2.Session.Rating.list", b24.Params{
"configId": 3,
"vote": "like",
"dateVoteFrom": "2026-06-01T00:00:00+02:00",
"dateVoteTo": "2026-06-30T23:59:59+02:00",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("imopenlines.v2.Session.Rating.list: %w", err)
}
fmt.Println(string(res.Result))
Response Handling
HTTP Status: 200
{
"result": {
"ratings": [
{
"sessionId": 1024,
"configId": 3,
"operatorId": 42,
"source": "livechat",
"vote": "like",
"voteHead": 5,
"commentHead": "Good work",
"dateVote": "2026-06-15T14:53:00+02:00",
"dateSessionClose": "2026-06-15T14:52:10+02:00"
}
],
"hasNextPage": false
},
"time": {
"start": 1782810000,
"finish": 1782810000.2,
"duration": 0.2,
"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 |
Description |
|
result |
Root response object |
|
result.ratings |
List of sessions with customer ratings. See all fields of the |
|
result.hasNextPage |
Indicates whether there is a next page |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "INVALID_FILTER",
"error_description": "Invalid vote filter value"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Statistics reports are not available on the current tariff plan |
The plan does not allow using Open Channels reports |
|
|
|
dateVoteFrom and dateVoteTo are required |
The |
|
|
|
Invalid filter value |
An invalid filter, date, or list with more than 1000 items was passed |
|
|
|
The requested period exceeds the maximum of 1 year |
The period is longer than 366 days |
|
|
|
Offset is too large |
|
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |