main.eventlog.list
Получить список записей журнала
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод main.eventlog.list возвращает список записей журнала событий по заданным условиям.
Параметры
select
array
необязательный
Список полей, которые нужно вернуть в ответе.
Доступные поля:
- id — идентификатор записи журнала
- timestampX — дата и время события
- severity — уровень важности события
- auditTypeId — тип события
- moduleId — идентификатор модуля
- itemId — идентификатор объекта
- remoteAddr — IP-адрес
- userAgent — User-Agent запроса
- requestUri — URI запроса
- siteId — идентификатор сайта
- userId — идентификатор пользователя
- guestId — идентификатор гостя
- description — описание события
filter
array
необязательный
Условия фильтрации записей в формате:
- ["field", "operator", value]
- ["field", value], оператор по умолчанию =
Доступные поля аналогичны полям в select.
Подробнее о работе фильтрации в REST 3.0
order
object
необязательный
Сортировка результатов в формате { "field": "value" }.
Доступные значения:
- ASC — по возрастанию
- DESC — по убыванию
Доступные поля для сортировки аналогичны полям в select.
pagination
object
необязательный
Параметры постраничной навигации:
- page — номер страницы
- limit — количество записей на страницу, по умолчанию 50
- offset — смещение записей. Если переданы page и limit, смещение вычисляется автоматически
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","timestampX","severity","auditTypeId","moduleId","itemId","userId","description"],"filter":[["timestampX",">=","2026-01-30T00:00:00+03:00"],["timestampX","<","2026-01-31T00:00:00+03:00"]],"order":{"id":"ASC"},"pagination":{"page":1,"limit":20,"offset":0}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/main.eventlog.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","timestampX","severity","auditTypeId","moduleId","itemId","userId","description"],"filter":[["timestampX",">=","2026-01-30T00:00:00+03:00"],["timestampX","<","2026-01-31T00:00:00+03:00"]],"order":{"id":"ASC"},"pagination":{"page":1,"limit":20,"offset":0},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/main.eventlog.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type EventLogItem = {
id: number
timestampX: ISODate | null
severity: string
auditTypeId: string
moduleId: string
itemId: string
remoteAddr: string
userAgent: string
requestUri: string
siteId: string
userId: number
guestId: number
description: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type EventLogListResult = {
items: EventLogItem[]
}
try {
// main.eventlog.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v3.callList.make() returns every record as one
// array, $b24.actions.v3.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 + `pagination` variant when sort matters.
const response = await $b24.actions.v3.call.make<EventLogListResult>({
method: 'main.eventlog.list',
params: {
select: [
'id',
'timestampX',
'severity',
'auditTypeId',
'moduleId',
'itemId',
'userId',
'description',
],
filter: [
['timestampX', '>=', '2026-01-30T00:00:00+03:00'],
['timestampX', '<', '2026-01-31T00:00:00+03:00'],
],
order: {
id: 'ASC',
},
pagination: {
page: 1,
limit: 20,
offset: 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('Event log entries:', result.items.length, result.items)
}
} 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 getEventLogList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// main.eventlog.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v3.callList.make() returns every record as one
// array, $b24.actions.v3.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 + `pagination` variant when sort matters.
const response = await $b24.actions.v3.call.make({
method: 'main.eventlog.list',
params: {
select: [
'id',
'timestampX',
'severity',
'auditTypeId',
'moduleId',
'itemId',
'userId',
'description',
],
filter: [
['timestampX', '>=', '2026-01-30T00:00:00+03:00'],
['timestampX', '<', '2026-01-31T00:00:00+03:00'],
],
order: {
id: 'ASC',
},
pagination: {
page: 1,
limit: 20,
offset: 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('Event log entries:', result.items.length, result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getEventLogList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
select = [
"id",
"timestampX",
"severity",
"auditTypeId",
"moduleId",
"itemId",
"userId",
"description",
]
filter = [
[
"timestampX",
">=",
"2026-01-30T00:00:00+03:00",
],
[
"timestampX",
"<",
"2026-01-31T00:00:00+03:00",
],
]
order = {
"id": "ASC",
}
pagination = {
"page": 1,
"limit": 20,
"offset": 0,
}
try:
bitrix_response = client.main.eventlog.list(
select=select,
filter=filter,
order=order,
pagination=pagination,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'main.eventlog.list',
[
'select' => [
'id',
'timestampX',
'severity',
'auditTypeId',
'moduleId',
'itemId',
'userId',
'description'
],
'filter' => [
['timestampX', '>=', '2026-01-30T00:00:00+03:00'],
['timestampX', '<', '2026-01-31T00:00:00+03:00']
],
'order' => [
'id' => 'ASC'
],
'pagination' => [
'page' => 1,
'limit' => 20,
'offset' => 0
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'main.eventlog.list',
{
select: [
'id',
'timestampX',
'severity',
'auditTypeId',
'moduleId',
'itemId',
'userId',
'description'
],
filter: [
['timestampX', '>=', '2026-01-30T00:00:00+03:00'],
['timestampX', '<', '2026-01-31T00:00:00+03:00']
],
order: {
id: 'ASC'
},
pagination: {
page: 1,
limit: 20,
offset: 0
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'main.eventlog.list',
[
'select' => [
'id',
'timestampX',
'severity',
'auditTypeId',
'moduleId',
'itemId',
'userId',
'description'
],
'filter' => [
['timestampX', '>=', '2026-01-30T00:00:00+03:00'],
['timestampX', '<', '2026-01-31T00:00:00+03:00']
],
'order' => [
'id' => 'ASC'
],
'pagination' => [
'page' => 1,
'limit' => 20,
'offset' => 0
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "main.eventlog.list", b24.Params{
"select": []string{"id", "timestampX", "severity", "auditTypeId", "moduleId", "itemId", "userId", "description"},
"filter": []any{
[]string{"timestampX", ">=", "2026-01-30T00:00:00+03:00"},
[]string{"timestampX", "<", "2026-01-31T00:00:00+03:00"},
},
"order": b24.Params{
"id": "ASC",
},
"pagination": b24.Params{
"page": 1,
"limit": 20,
"offset": 0,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("main.eventlog.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "items".
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
return fmt.Errorf("в ответе нет ключа items")
}
var items []struct {
ID b24.ID `json:"id"`
TimestampX string `json:"timestampX"`
Severity string `json:"severity"`
AuditTypeID string `json:"auditTypeId"`
ModuleID string `json:"moduleId"`
ItemID b24.ID `json:"itemId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Ответ
HTTP-статус: 200
{
"result": {
"items": [
{
"id": 443585,
"timestampX": "2026-01-22T02:52:25+03:00",
"severity": "SECURITY",
"auditTypeId": "USER_AUTHORIZE",
"moduleId": "main",
"itemId": "751",
"userId": 751,
"description": "{\u0022userId\u0022:751,\u0022requestId\u0022:\u00225636cd3e45c524c55a68a19dccb72c3b-0\u0022,\u0022method\u0022:\u0022external\u0022}"
},
// ...
{
"id": 443623,
"timestampX": "2026-01-22T05:21:51+03:00",
"severity": "SECURITY",
"auditTypeId": "USER_AUTHORIZE",
"moduleId": "main",
"itemId": "751",
"userId": 751,
"description": "{\u0022userId\u0022:751,\u0022requestId\u0022:\u002239aae4ca278ad75ca3dc631c7b4f8fe2-0\u0022,\u0022method\u0022:\u0022external\u0022}"
}
]
},
"time": {
"start": 1769773532,
"finish": 1769773532.960023,
"duration": 0.9600229263305664,
"processing": 0,
"date_start": "2026-01-30T14:45:32+03:00",
"date_finish": "2026-01-30T14:45:32+03:00",
"operating_reset_at": 1769774132,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект с данными ответа
items
array
Массив объектов записей журнала
items[]
object
Объект записи журнала
id
integer
Идентификатор записи журнала
timestampX
datetime
Дата и время события
severity
string
Уровень важности события
auditTypeId
string
Тип события
moduleId
string
Идентификатор модуля
itemId
string
Идентификатор объекта
remoteAddr
string
IP-адрес
userAgent
string
User-Agent запроса
requestUri
string
URI запроса
siteId
string
Идентификатор сайта
userId
integer
Идентификатор пользователя
guestId
integer
Идентификатор гостя
description
string
Описание события
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION",
"message": "Не удается распознать параметр пагинации `{\"limit\":\"abc\"}`"
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
| — | Доступ запрещен | Нет прав администратора или не хватает scope main |

