Get a List of Datasets biconnector.dataset.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:
biconnectorWho can execute the method: a user with access to the Analytics hub section
The biconnector.dataset.list method returns a list of datasets by filter. It is a list-based method implementation for datasets.
Method Parameters
|
Name |
Description |
|
select |
A list of fields that must be populated in the datasets in the selection. By default, all fields are taken. |
|
filter |
Filter for selecting datasets. Example format:
A prefix can be added to the
The list of available fields for filtering can be obtained using the biconnector.dataset.fields method. The filter does not support the |
|
order |
Sorting parameters. Example format:
where:
|
|
page |
Controls pagination. The page size of results is 50 records. To navigate through results, pass the page number |
Code Examples
How to Use Examples in Documentation
Retrieve a list of sources where:
- the name starts with
Sales - the description is not empty
- the source identifier equals
2or4
For clarity, select only the necessary fields:
- identifier
id - name
name - description
description
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id", "name", "description"],
"filter": {
"%=name": "Sales%",
"!description": "",
"@sourceId": [2, 4]
},
"order": {
"dateCreate": "DESC"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.dataset.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id", "name", "description"],
"filter": {
"%=name": "Sales%",
"!description": "",
"@sourceId": [2, 4]
},
"order": {
"dateCreate": "DESC"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.dataset.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each DatasetItem returned in result[]
type DatasetItem = {
id: string
name: string
description: string
}
try {
// biconnector.dataset.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<DatasetItem[]>({
method: 'biconnector.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'Sales%',
'!description': '',
'@sourceId': [2, 4],
},
order: {
dateCreate: 'DESC',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Datasets page:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listDatasets() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// biconnector.dataset.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'biconnector.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'Sales%',
'!description': '',
'@sourceId': [2, 4],
},
order: {
dateCreate: 'DESC',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Datasets page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDatasets)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.dataset.list(
select=[
"id",
"name",
"description",
],
filter={
"%=name": "Sales%",
"!description": "",
"@sourceId": [
2,
4,
],
},
order={
"dateCreate": "DESC",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'biconnector.dataset.list',
[
'select' => ["id", "name", "description"],
'filter' => [
'%=name' => "Sales%",
'!description' => "",
"@sourceId" => [2, 4]
],
'order' => [
'dateCreate' => "DESC"
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($response->getError()) {
error_log($response->getError());
echo 'Error: ' . $response->getError();
} else {
echo 'Success: ' . print_r($result, true);
// The data processing logic you need
processData($result);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling biconnector.dataset.list: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.dataset.list',
{
select: ["id", "name", "description"],
filter: {
'%=name': "Sales%",
'!description': "",
"@sourceId": [2, 4]
},
order: {
dateCreate: "DESC"
}
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.dataset.list',
[
'select' => ["id", "name", "description"],
'filter' => ['%=name' => "Sales%", '!description' => "", '@sourceId' => [2, 4]],
'order' => ['dateCreate' => "DESC"]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "biconnector.dataset.list", b24.Params{
"select": []string{"id", "name", "description"},
"filter": b24.Params{
"%=name": "Sales%",
"!description": "",
"@sourceId": []int{2, 4},
},
"order": b24.Params{
"dateCreate": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.dataset.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result": [
{
"id": "9",
"name": "sales_data_main",
"description": "Monthly sales report"
},
{
"id": "6",
"name": "sales_data_first_filial",
"description": "Monthly sales report for first filial"
},
{
"id": "5",
"name": "sales_data_second_filial",
"description": "Monthly sales report for second filial"
}
],
"time": {
"start": 1743061675.963969,
"finish": 1743061676.064591,
"duration": 0.10062193870544434,
"processing": 0.011152029037475586,
"date_start": "2025-03-27T07:47:55+00:00",
"date_finish": "2025-03-27T07:47:56+00:00"
}
}
Returned Data
|
result |
Response root element. Contains an array of objects with information about datasets. Note that the field structure may change due to the |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 200
{
"error": "VALIDATION_SELECT_TYPE",
"error_description": "Parameter \"select\" must be array."
}
|
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
|
Code |
Description |
Value |
|
|
Parameter "select" must be array. |
The |
|
|
Parameter "filter" must be array. |
The |
|
|
Parameter "order" must be array. |
The |
|
|
Field "#TITLE#" is not allowed in the "select". |
These fields are not allowed in the selection |
|
|
Field "#TITLE#" is not allowed in the "filter". |
These fields are not allowed in the filter |
|
|
Field "#TITLE#" is not allowed in the "order". |
These fields are not allowed for sorting |
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 |