Skip to main content

Journal

The Journal module in OneEntry lets administrators track what other admins do in the system and how the public Content API is used. The module has four tabs:

TabWhat it shows
Admin action logAll administrator actions in the system: creating, modifying, and deleting entities.
Admin trafficAdministrator login sessions: when they logged in, when they logged out, and from which device.
Content API statisticsCall counts for all public site endpoints over different periods.
Content API errorsAll 4xx/5xx responses of the public API, with request details and a stack trace.

In the module interface, the tabs are labeled Admin Journal, Access Log to Admin Application, Content API Statistics, and Content API Errors.

The Content API statistics and errors tabs require separate permissions. See Journal permissions.


Admin action log​

The main tab. It shows all administrator actions in the system.

Interface elements​

The tab has two blocks:

  • Filters
  • List of actions

Filters​

You can filter actions by the following fields:

  1. From: a text field for the start date of the period to filter by.
  2. To: a text field for the end date of the period to filter by.
Date fields

Type a date in your region's date format, or pick it from the calendar that opens when you click the field.

  1. Administrator ID: a numeric field for the administrator's unique identifier.
  2. User actions: a dropdown list of user actions:
    • Creation
    • Modification
    • Deletion
  3. Status: a dropdown list of action statuses:
    • Successful
    • Error
  4. Module name: a dropdown list of module names:
    • Administrators
    • Sets of attributes
    • Backup
    • Managing blocks
    • Event management
    • General settings
    • Uploading files
    • File editor
    • Managing forms
    • Localization
    • Markers
    • Menu
    • Modules
    • Content management
    • Products
    • Order management
    • Basic settings
    • Payment management
    • Product status management
    • USER
    • Authentication providers and users management
    • Template management
    • Preview template management
  5. Record ID: a numeric field for the record's unique identifier.

Below the filters are two buttons:

  • Delete data deletes admin action log entries for the period set in the From / To fields (see Manual log cleanup).
  • Reset clears the applied filters.

List of actions​

The list of actions is a table with six columns:

  1. User actions
  2. Status
  3. User login
  4. Module name
  5. Record ID
  6. Date and time
Sorting

Click a column header to sort by that column. The first click sorts in descending order, the second in ascending order, and the third resets the sorting.

Block visibility audit​

Every block visibility toggle (the show/hide toggle in the blocks section of the admin panel) is recorded in the admin action log automatically, so you can see which admin changed the state of a specific block and when.

In the list of actions, these entries belong to the Managing blocks module.


Admin traffic (Admin Access Log)​

The Admin traffic tab records each administrator login and logout as a separate entry. It shows who logged in to the admin panel and when, which is useful for auditing.

Table columns​

The table has six columns:

ColumnMeaning
LoginAdministrator login
IPIP address the admin logged in from
Login TimeDate and time of login
Logout TimeDate and time of logout (Active for a session that is still open)
DurationSession length (for an active session, from login to the current moment)
ReasonWhy the session closed: Logout (the admin clicked "Log out") or Admin Revoked (another admin forcibly ended the session); Active for an open session
Sorting

As in the admin action log, you can sort any column by clicking its header.

Authorization expiration

Authorization expiration and automatic renewal are not recorded as separate entries. An expired session is marked as closed only once it stops being used, not right away.

Filters​

  • From / to: the period (date fields with a calendar).
  • Administrator ID: a numeric field to filter by a specific administrator.
  • Session Status: a dropdown list of session statuses: All / Active / Closed.

Delete data button​

Deletes session records for the period set in the From / To fields. Clicking the button opens a confirmation dialog:

Confirm action: Delete all closed sessions for the specified period? This action is irreversible. Active sessions will remain.

Only closed sessions are deleted. Active sessions (with open authorization) are kept.


Content API statistics​

The Content API statistics tab shows call counts for all public site endpoints over 1 hour, 24 hours, or 7 days.

What it shows​

  • A list of all public endpoints (GET /api/content/...). The list is built automatically; you don't need to fill it in.
  • A counter next to each endpoint: how many times it was called during the selected period.

Interface elements​

  • Period: a dropdown list of periods: Last Hour / Last 24 Hours / Last 7 Days (Last 24 Hours by default).
  • Refresh: a button that forces a data refresh.

The data is shown in a table with four columns:

ColumnMeaning
PathEndpoint path (/api/content/...)
MethodHTTP method (GET, POST, …)
DescriptionShort description of the endpoint
RequestsNumber of calls during the selected period

The top of the page shows the Auto-cleanup not applicable banner. Statistics are read in real time and are not stored in the project, so there is nothing to clean up, and the data retention period can't be configured in the admin panel.

Metric temporarily unavailable

If statistics are temporarily unavailable, the warning "Metric temporarily unavailable. All endpoints are displayed with a zero count." appears above the table. Despite this text, the table may be empty in this case and show "No data available".

Statistics retention

Statistics are kept for a limited time, and the retention period can't be configured in the admin panel. To analyze a longer period, save the data yourself. The banner at the top of the page warns about this.

Why use it​

The statistics show which Content API endpoints are used and which are never called. A sharp drop in calls to one endpoint usually points to a problem in the client application.

Update frequency

Data updates at most once a minute: clicking Refresh again within 60 seconds shows the same values.


Content API errors​

The Content API errors tab shows all 4xx/5xx responses the public API returned during a period. Developers integrating a client application with the Content API can see errors from their requests right in the admin panel.

What it shows​

Each entry is one HTTP error. The table has five columns:

ColumnMeaning
TimeError timestamp
StatusHTTP status (4xx / 5xx)
MethodRequest method (GET, POST, …)
PathPath (/api/content/...)
MessageError text

If there were no errors during the selected period, the message "No errors recorded for the selected period" appears instead of the table.

Click a table row to open a window with the error details:

  • time, HTTP status, method, and request path;
  • error code and text;
  • full stack trace (up to 8 KB);
  • request ID and the serial number of the app-token the request came with;
  • client IP address and User-Agent;
  • Query: query string parameters;
  • a preview of the request body with secrets removed (passwords, tokens, and authorization headers are masked).

Filters​

  • From / to: the period (date fields with a calendar).
  • HTTP Status: a dropdown list of statuses. Select a group (4xx - Client-side, 5xx - Server-side) or a specific code: 400, 401, 403, 404, 422, 500, 502, 503.
  • Path: a text field to filter by path (for example, /api/content/blocks/*).

Delete data button​

Deletes error records for the period set in the From / To fields. If no period is set, it deletes all errors.

Security: hiding sensitive data​

Sensitive data in error records is hidden automatically. The fields password, token, authorization, api_key, x-app-token, cookie, and set-cookie (case-insensitive) are replaced with ***. Large request bodies are truncated to 2 KB.


Manual log cleanup​

Journal entries are cleared manually. Every tab that stores entries has a Delete data button:

TabWhat it deletes
Admin action logAdmin action entries for the selected period
Admin trafficOnly closed sessions for the selected period
Content API errorsError records for the selected period

Set the period to delete in the From / To fields of the tab's filters. If no period is set, all records of that type are deleted. A Confirm action dialog always appears before deletion, and the operation can't be undone.

Active sessions are kept

The Delete data button on the Admin traffic tab does not delete active admin sessions. Even if the period overlaps the current moment, a colleague's open session is not deleted. Only closed sessions are deleted.

The Content API statistics tab has no cleanup

Statistics are read in real time and are not stored in the project, so this tab has no Delete data button. The "Auto-cleanup not applicable" banner says so.


Journal permissions​

The Content API Statistics and Content API Errors tabs require separate permissions in the permissions tree (opens in a new tab). Without the permission, the tab is hidden.

TabPermission
Content API statisticsjournal.viewContentApiStats
Content API errorsjournal.viewContentApiErrors

The admin action log and admin traffic tabs are visible to all administrators who have access to the journal module.