/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[<columnId>]=<value> repeated, ?group=<groupId>) and figures over the rows in it. Computed columns (formula, lookup) are left out.
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 id; the value may be a select's option label, a person's name or email, or the stored value, in any case
Responses
the action's answer
{
"data": {
"columns": [
"string"
],
"total": 1.5
}
}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"
}