/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[<columnId>]=<value> repeated, ?group=<groupId> — and then counts only the rows in it, so a paged grid can draw its filter panel without the rows.
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": [
{
"columnId": "",
"key": "string",
"label": "string",
"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"
}