Event Log: Overview of Methods

The event log records user actions in Bitrix24: logins, password change requests, and various system operations. The available events depend on the Bitrix24 plan.

Quick navigation: all methods

User documentation: What is the Event Log in Bitrix24

The methods main.eventlog.* allow you to:

• export events based on a filter,
• retrieve a specific record,
• set up regular updates for new data,
• get descriptions of available log record fields.

When to Use Each MethodWhen to Use Each Method

Use main.eventlog.get when you need to get details of a specific event by ID.

The methods main.eventlog.list and main.eventlog.tail are similar but serve different purposes.

Use main.eventlog.list when you need to:

• generate a report for a period,
• find events based on complex criteria,
• implement search and navigation through history.

Use main.eventlog.tail when you need to:

• set up real-time monitoring,
• synchronize an external system with the log,
• track new events after a certain threshold.

Use main.eventlog.field.list and main.eventlog.field.get when you need to:

• learn about available fields for select, filter, and order,
• get types and metadata for a specific field,
• automatically build filtering interfaces and tables.

Overview of MethodsOverview of Methods

Scope: main

Who can execute the method: administrator

Method	Description
main.eventlog.list	Returns a list of log records based on a filter
main.eventlog.get	Returns a log record by identifier
main.eventlog.tail	Returns new log records after a specified point
main.eventlog.field.list	Returns a list of log record fields
main.eventlog.field.get	Returns the description of a log record field by name

Continue LearningContinue Learning

• Get the list of event log entries main.eventlog.list
• Get Event Log Entry main.eventlog.get
• Get New Log Entries main.eventlog.tail
• Get the List of Event Log Fields main.eventlog.field.list
• Get Event Log Field main.eventlog.field.get
• Overview of REST API 3.0