Tables

Aggregate table rows

Sum, count, average, min or max a field, optionally grouped by up to three fields and filtered. Set computed: true to read the derived document instead of the stored one. A read, expressed as POST because the filter set does not fit a query string. Prefer POST /{tableId}/rows/query, which answers rows, groups and calculations over one filtered set.

post/v1/tables/{tableId}/rows/aggregate

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/tables/{tableId}/rows/aggregate
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

tableIdstring required

Table ID

Request body

fieldKeystring
computedboolean
op'sum' | 'count' | 'avg' | 'min' | 'max' required
groupBystring[]
limitinteger

Response

Aggregate groups

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.