TablesRead-only

Aggregate table rows

aggregate_table_rows

Compute sum / count / avg / min / max over a table field, optionally grouped by up to three fields and filtered — the fast way to answer "what did I spend on groceries last month" without paging through rows. Formula, rollup, lookup and count fields are materialised, so they aggregate exactly like a stored number. Money fields are grouped by currency unless you explicitly ask for a mixed-currency total.

Parameters

Parameter	Type	Required	Description
`tableId`	string	required	Table ID — get from list_tables
`op`	"sum" \| "count" \| "avg" \| "min" \| "max"	required	Aggregation to compute
`fieldKey`	string	optional	Field key to aggregate. Required for everything except count.
`groupBy`	string[]	optional	Field keys to group by, e.g. ["category"] or ["accountName", "currency"]
`filters`	object[]	optional	Field filters, ANDed together
`limit`	integer	optional	Maximum groups returned (max 5000)
`mixedCurrencies`	boolean	optional	Set true to sum or average a money field ACROSS currencies. Without it, a money field is grouped by the table’s currency field so amounts in different currencies are never added together.

Example call

The tool call an MCP client sends (required arguments shown with placeholder values).

{
  "tool": "aggregate_table_rows",
  "arguments": {
    "tableId": "tableId_123",
    "op": "value"
  }
}

Use this tool in

Claude Code Claude Desktop Claude Cowork ChatGPT Cursor Windsurf VS Code Copilot OpenClaw Gemini Hermes Agent

Related Tables tools

List tableslist_tablesList the tables in the workspace (id, name, kind — typed or custom — resource type, fields, row count, schema/revision versions).Get tableget_tableGet one table by id: its full field set (key, label, kind, display format, select options, whether the field is feed-owned and whether it can be written), the fields that form row identity, the promoted primary/date/amount bindings, row count, and its schema badge.Create tablecreate_tableCreate a table in the workspace.Update tableupdate_tableUpdate a table’s METADATA — name, icon, retention policy.

← All tools