Filter
Requires access scope.
A selectable option within a Filter, such as a specific color, size, or product type. Each value includes a count of matching results and a human-readable label for display.
The input field provides ready-to-use JSON for building dynamic filtering interfaces. You can combine the input values from multiple selected objects to construct filter queries. Visual representations are available through the image or swatch fields when the parent filter's presentation type supports them.
Anchor to FieldsFields
- count (Int!)
- id (String!)
- image (MediaImage)
- input (JSON!)
- label (String!)
- swatch (Swatch)
- Anchor to countcount•Int!non-null
The number of results that match this filter value.
- •String!non-null
A unique identifier.
- Anchor to imageimage•Media
Image The visual representation when the filter's presentation is
.- Anchor to inputinput•JSON!non-null
An input object that can be used to filter by this value on the parent field.
The value is provided as a helper for building dynamic filtering UI. For example, if you have a list of selected
objects, you can combine their respectiveinputvalues to use in a subsequent query.- Anchor to labellabel•String!non-null
A human-friendly string for this filter value.
- Anchor to swatchswatch•Swatch
The visual representation when the filter's presentation is
.