/v1/definitions/{key}/aggregatesSum, count or average a page's records
The calculations strip of a record page: how many rows, and one figure per column that carries a calculation (sum, average, median, min, max, filled, empty, percent filled/empty, unique, earliest, latest) — the way to answer "what is the total loan amount" or "how many leads have a phone" without listing rows. Takes the rows route's narrowing (?q=, ?filter[<column label or id>]=<value> repeated, ?group=<groupId>, ?view=<tab>, and ?dealRowId= on a page that links to Deals) and figures over the rows in it. Computed columns (formula, lookup) are left out. ?groupBy=<column label or id> (twice for a cross-tab; a date as <column>:month|week|day) answers the count and figures per group, largest first — "submissions by lender and status" in one call; a board is board-<id without dashes>. ?filter[$created]=>=2026-10-01 narrows by when the row was made ($updated: last changed) and ?groupBy=$created:month groups by it, so "deals by stage this month" needs no date column. A DATE or datetime column takes the same bounds: ?filter[<its column id>]=>=2026-09-20 keeps the rows whose date is on or after the 20th (repeat for a range; a bare value is still the exact stored text) — so "deals funded in the last 30 days, and for how much" is ONE aggregates read over the Funded Date column, never the accounting ledger. ?calculate=Funded:sum (repeated; any of sum, average, median, min, max, filled, empty, percent_filled, percent_empty, unique, earliest, latest) figures a column the page carries no calculation on, or replaces the one it carries — the strip otherwise totals only the columns its admin set, so "for how much" is asked here. ?view=<tab> reads one of the page's tabs (a band of its status — Underwriting on deals — or one status), as the rows read does; a status filter valued by a tab's name means that tab.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
one entry per column: {"": ""}, or a list to match any of several — sent as filter[]= in the query string. The key is a column's label (any case) or its id — a label two columns share is refused, send the id; the value may be a select's option label, a person's name or email, or the stored value, in any case; a value opening with ~ keeps the cells CONTAINING the text after it, any case ("~phoenix"; a literal leading ~ is sent as ~). The reserved key $messages takes replied (their email or text is the newest on the record, unanswered) or sent (ours is, no answer yet), and a date bound on when that last word was written beside it: ["sent", "<2026-10-15"] is no answer since before the 15th
Responses
the action's answer
{
"data": {
"columns": [
"string"
],
"groupBy": [
{
"bucket": "string",
"columnId": "",
"label": "string"
}
],
"groupCount": 1,
"groups": [
{
"columns": "string",
"count": "string",
"keys": "string"
}
],
"note": "string",
"total": 1.5,
"truncated": true
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}