logmanager/ endpoint provides access to the logs recorded in the shop system. It lets you retrieve individual logs or entire log lists as well as perform targeted analyses by filtering by parameters such as severity, subshop or timestamp.
In addition, log groups can be created and managed to save specific filter criteria and receive notifications about new relevant entries.
The API therefore supports both manual analysis and automated monitoring of system events.
The corresponding access rights are required to use the interfaces.
Supported methods
List of all supported methods.Resources: fields in logs
Important data fields in logs
Logs in the system are based on data from Elasticsearch and therefore do not follow a rigid structure. Nevertheless, there are central fields that appear in almost all log entries and can be used for filters, sorting or evaluation. The following overview lists the most important of these fields:
Note: Additional fields may be present depending on the origin and context of the log. The actual structure of individual log entries can vary.
Example
The following log entry comes from the system and shows typical fields as returned by Elasticsearch. Optional fields such asagent, host or tags may vary depending on the origin of the log.
Programs that produce logs
Theapp field in a log entry indicates which program or service generated the log. The following overview lists the possible programs that can appear as the app value in practice — including a brief description of their task within the shop system.
Methods for logs
The following endpoints let you retrieve log entries from the system. The logs contain detailed information about events in the shop, such as error messages, debug output or security-relevant hints. Entries can be filtered and sorted as well as loaded individually by their ID. For access to this data, the corresponding read permissions are required.GET logmanager/logs
This endpoint can be used to query a list of log entries. The results can be filtered and sorted by timestamp, severity (severity), shop, subshop, logger, session ID or other fields. By default, sorting is done by the @timestamp field. For the query, a time range can be specified with filter_gte[createdAt] and filter_lte[createdAt]. Access is limited to a maximum of 300 entries per request; pagination is done via nextPageToken.
The maximum number of results is 10,000 — even with pagination. Data beyond that cannot be retrieved.
Logs of various applications (e.g. shop, restapi) and sources (e.g. filebeat) are available. They contain structured metadata and error messages that serve to analyze processes or errors in the shop. To determine the actual log files or paths, the log.file.path field can be used.
Example
Access up to 100 logs of any kind in the period 2025.03.24–2025.04.24Response
Filter fields
logger (if not specified — all), createdAt (instead of @timestamp), other fields of a log such as subshopId, severity, app
Sort fields
It is possible to sort logs by different fields (e.g. bysessionId.keyword), but by default only sorting by @timestamp is used.
Error codes
GET logmanager/logs/{id}
This method loads a single log event by its ID. All associated fields are returned, such as timestamp, source, severity, message and context information. To use this method, the corresponding read permissions for logs must be available.Example
Response
Error codes
Methods for log groups
Through the following endpoints, log groups can be created, retrieved, updated and deleted in the shop system. Log groups define which types of logs are to be observed — e.g. by severity, subshop or source — and form the basis for targeted evaluations and notifications. In addition, notification settings of a group can be configured to receive regular information about new log entries. To use the interfaces, the corresponding permissions to manage logs are required.GET logmanager/groups
This endpoint can be used to query log groups. A log group bundles certain log entries based on a configurable filter, e.g. by severity or time range. The result list can be limited via filter and sort parameters. For access to this data, the corresponding read permissions are required.Example
Response
Filter fields
id, name, description, notificationId, filter, createdAt
Sort fields
id, name, description, createdAt
Error codes
GET logmanager/groups/{id}
This endpoint can be used to retrieve a single log group by its ID. The log group contains metadata such as name, description, time of creation, filter, and an optional reference to a notification configuration. For access, the corresponding read permissions are required.Example
Response
Error codes
GET logmanager/groups/{id}/logs
This endpoint can be used to retrieve a list of logs that belong to a specific log group. The ID of the log group must be provided in the URL. The query supports filtering, sorting and pagination via thesize, sort and pageToken parameters.
For access, the corresponding read permissions must be available.
Example
Response
Error codes
GET logmanager/groups/{id}/notifications
This endpoint can be used to retrieve the notification settings of a specific log group. This includes the recipients, the notification period and the time of the last sending, among other things. The ID of the log group must be provided in the URL. For access, the corresponding read permissions are required.Example
Response
Error codes
POST logmanager/groups
This endpoint can be used to create a new log group. Mandatory fields arename and filter; the description field is optional. The filter defines which logs should be assigned to the group. Filters consist of nested logical conditions (e.g. or, and, eq).
To use the endpoint, the required permissions to create log groups must be available.
Example
Request body
Response
notificationId: 0 because no notification configuration has been assigned yet. It can then be set up via PUT logmanager/groups/{id}/notifications.