# Read 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`.

## Endpoint

`GET /v1/definitions/{key}/facets`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| key | path | string | Yes |
| body | query | null | No |
| params | query | object | No |
| query | query | object | No |

## Responses

### 200

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "columns": [
      {
        "columnId": "",
        "key": "string",
        "label": "string",
        "values": [
          {
            "color": "string",
            "count": 1.5,
            "label": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}
```

### default

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.

Content type: `application/json`.

```json
{
  "error": "string"
}
```