/v1/definitions/{key}/facetsRead a page's filter facets
Per-column value counts for a record page — how many rows sit in each status, stage or option. The cheap way to answer "how many … are …" without listing rows. Takes the rows route's narrowing — ?q= (substring over every cell), ?filter[<column label or id>]=<value> repeated, ?group=<groupId>, ?dealRowId= on a page that links to Deals — and then counts only the rows in it, so a paged grid can draw its filter panel without the rows; ?filter[$created]=>=2026-10-01 (or $updated) counts only the rows made (last changed) in that span. Also answers a $messages column (Messages: replied / sent) counting records by who wrote last on their email and text threads — the cheap way to answer "how many leads replied"; filter the rows route with the same word to list them. A relation column is counted by the linked record (its 50 largest), labelled with the record's name. 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. ?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": [
{
"columnId": "",
"key": "string",
"label": "string",
"truncated": true,
"values": [
{
"color": "string",
"count": 1.5,
"label": "string",
"value": "string"
}
]
}
]
}
}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"
}