Skip to main content

systemLogs

The SystemLogs query is used to retrieve log entries from the system. It requires a SystemLogFilterInput object as an argument, which is used to filter the results. Each field in the SystemLogFilterInput corresponds to a specific attribute in the log entries and is optional. If a field is provided, the query will return only the log entries that match the provided value for that field.

ArgumentTypeDescription
filtersSystemLogFilterInputAn object used to filter the results of the SystemLog query.

Please note that the entity_id and entity_type fields must be provided, or an error will be raised. The log_type, operation, and message fields are optional and can be used to further filter the results.

The query returns an array of SystemLogType objects. Each SystemLogType object represents a log entry and includes the following fields: log_type, operation, message, entity_id, entity_type, created_at, and updated_at.

Possible errors include EntityError if the entity_id and entity_type fields are not provided, and AuthenticationError if the user is not authenticated.

systemLogs(
  filters: SystemLogFilterInput!
): [SystemLog!]!

Arguments​

systemLogs.filters ● SystemLogFilterInput! non-null input​

Type​

SystemLog object​

The SystemLogType object represents a system log entry. It includes fields for the log type (info, error, warning, success), the operation performed, the message associated with the log entry, the ID and type of the entity associated with the log entry, and timestamps for when the log entry was created and updated.