Get Logs
Returns a list of filtered log entries from a project with various expressiveness options:
-
Monolithic mode (when group_by is not provided):
- Returns a flat list of log entries (with fields clipped if value_limit is set).
- Optionally factors out repeated fields into a grouped_entries field if group_threshold is set.
-
Grouped mode (when group_by is provided):
- Supports multi-level grouping of logs. The order of fields in group_by dictates the nesting order.
- Supports pagination at the group level using group_limit and group_offset.
- Supports limiting the nesting depth with group_depth.
- When nested_groups is True, returns a nested structure under the “logs” key.
- When nested_groups is False, returns flat per-field mappings under the “groups” key.
- When groups_only is True, the detailed log objects are omitted and leaves are simplified
to either lists of log ids (if return_timestamps is False) or mappings of
{log id: timestamp}(if True).
-
Return IDs only mode:
- If return_ids_only is True, returns only the log event ids.
- If return_versions is also True, returns a list of objects with both id and version information.
The response always includes:
params: The parameter versions used across the logs.count: The total number of logs matching the query.- Additionally, it includes either
logs(in monolithic or nested grouping mode) orgroups(in flat grouping mode) as specified by the arguments.
If return_versions=True:
- Returns all versions of logs in versioned contexts
- from_ids and exclude_ids must be provided as lists of objects with ‘id’ and ‘version’ keys
- Each object must have format:
{"id": log_event_id, "version": version_number} - This is only valid for logs in versioned contexts
If return_versions=False (default):
- Returns only the latest version of each log
- from_ids and exclude_ids should be strings of ’&‘-separated log event IDs
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Name of the project to get entries from.
The context (prepending ’/’ seperated field names) from which to retrieve the logs.
Static context to filter logs by.
Whether to return all versions of logs. Only valid for versioned contexts.
When set, entries that appear in at least this many logs will be grouped together.
Maximum number of characters to return for string values.
Boolean string to filter entries. TODO: Detailed page.
Dict with fields as keys and either ‘ascending’ or ‘descending’ as values. The first entry in the dict is the last field to be sorted by, which takes ultimate precedent, with other keys only remaining in order when the first key values are equal.
Sorting configuration for groups when using group_by. Specifies how to sort groups relative to each other based on aggregated metrics.
The log ids which are permitted to be included in the search. Each log id listed does not need to be returned, but no logs which are not included in this list can be returned. This argument cannot be set if exclude_ids is set.
The log ids which cannot be returned from the search. None of the listed ids will be returned, even if the logs are valid as per the filtering expression etc. This argument cannot be set if from_ids is set.
The fields which are permitted to be included in the search. Each field listed does not need to be returned, but no fields which are not included in this list can be returned. This argument cannot be set if exclude_fields is set.
The fields which cannot be returned from the search. None of the listed fields will be returned, even if the fields are valid as per the filtering expression etc. This argument cannot be set if from_fields is set.
List of fields to group results by. Results will be nested based on these fields.
Maximum number of groups to return at each level
Number of groups to skip at each level
Maximum depth of nested groups to return. If not specified, all levels are returned.
If True, groups are returned as a nested structure; if False, groups are returned as flat per-field mappings.
If True, do not include a full logs list; only return groups (with leaf values being either log ids or timestamps).
When groups_only is True, return each leaf as a mapping from log id to timestamp instead of just a list of log ids.