query_records

Search, filter, sort, paginate, and aggregate records in a collection. Use action='search' (default) for raw records, action='aggregate' for grouped analytics (count, sum, avg, min, max).

Filter and sort expressions use the Filter DSL syntax.

Parameters

NameTypeRequiredDescription
workspace_idstringYesTarget workspace ID
collectionstringYesCollection name or ID
actionenumYes'search' returns records (default). 'aggregate' returns grouped aggregations.
filterobjectNo
sortarrayYes
fieldstringYes
directionenum: asc | descNoSort order
limitnumberNoMax records to return
offsetnumberNoPagination offset
fieldsarrayNoSubset of fields to return (search only)
external_sourcestringNoQuery a specific external source (e.g. 'stripe'). Search only.
aggregationsarrayYes
fnenum: count | sum | avg | min | maxYes
fieldstringNo
aliasstringNoAggregation functions. Required when action='aggregate'. count needs no field; sum/avg/min/max require field.
group_byarrayNoFields to group by (e.g. ['data.status']). Used with action='aggregate'.