Aggregate the records in a database
Computes one aggregate in the database - `fn` is `count` (the default), `sum`, `avg`, `min` or `max` - over the records matching the optional `viewId`'s filters, and returns the value with the number of contributing records. Every function except `count` needs a `field` key. Requires the `records:read` permission; an unsupported function, an unknown field key and an unknown view are all rejected.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Query Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/databases/string/records/aggregate"{ "data": { "value": 0, "count": 0 }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Read a page of records through a view
Returns one window of records with the filters and sorts of `viewId` applied in the database, plus the shape id and workspace version a realtime client needs to reconcile later updates. Paginated: pass `limit` and the `cursor` from the previous response's `window`. Requires the `records:read` permission; a view that does not exist or is another user's personal view responds with not-found. Responses are cached per caller for a few seconds.
Read a single record
Returns one record with its cell values, linked-record titles and computed fields. Requires the `records:read` permission and responds with not-found when the record is not in the database.