Filtering & Search¶

List endpoints accept a filter query parameter using a small expression language.

Basic filters¶

GET /v1/buckets/my-first-bucket/records?filter=value>10

Supported operators: =, !=, >, >=, <, <=.

Combining filters¶

Join multiple conditions with and / or, and group with parentheses:

GET /v1/buckets/my-first-bucket/records?filter=(value>10 and value<100) or name="hello-world"

Full-text search¶

For free-text queries across record fields, use the dedicated Search endpoint instead of filter:

GET /v1/search?q=hello&bucket=my-first-bucket

Filter vs. search

filter matches exact field comparisons and is fast on indexed fields. search does fuzzy full-text matching and is better for user-facing search boxes.

Indexing fields for filtering¶

Only indexed fields can be used in filter. Add an index in nimbus.yml:

nimbus.yml

buckets:
  - name: my-first-bucket
    indexes: [value, created_at]