Skip to content

docs: add info about sorting #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
softlukas merged 2 commits into from
Jul 21, 2026
Merged

docs: add info about sorting #43

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3eef681
docs: add info about sorting
Jul 21, 2026
d5306e1
docs: remove ip from sort examples
Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,8 @@ There are no attribute name checks (may be added in the future).

Generic and fulltext filters are merged - fulltext overrides conflicting keys.

Sorting is supported by entity ID using the special attribute `eid`, as well as for plain and observations attributes with primitive data types (excluding json and multi_value observations). To sort by multiple attributes, provide multiple sort parameters in the format `attribute:direction` where direction is `1` (ascending) or `-1` (descending). Direction defaults to `1` if not provided. Default is no sorting. Examples: `?sort=eid:1`, `?sort=hostname:-1&sort=rep_score:1`

### Request

`GET /entity/<entity_type>/get`
Expand All @@ -243,6 +245,7 @@ Generic and fulltext filters are merged - fulltext overrides conflicting keys.
- limit: how many entities to return (default: 20)
- fulltext_filters: dictionary of fulltext filters (default: no filters)
- generic_filter: dictionary of generic filters (default: no filters)
- sort: list of sort specifications (default: no sorting)

### Response

Expand Down
Loading