Content widgets schema
Reference for the Advanced Filter (JSON) structure used in content widgets and Content Listing Blocks.
Overview
This page documents the structure of the Advanced Filter (JSON) field. For guidance and examples, see Advanced filter (JSON).
Config
| Property |
Description |
Type |
Filter |
The top-level filter group to apply. |
Object (AdvancedFilterGroup) |
AdvancedFilterGroup
| Property |
Description |
Type |
Default |
Mode |
Whether All or Any items/groups must match for this group filter to be satisfied. Values: All, Any, NotAll. |
Enum |
All |
Items |
A collection of filter items for this group. If multiple properties of an individual filter item are populated, they must all be matched for the filter item to be satisfied. |
Object (AdvancedFilterItem) |
|
Groups |
A collection of child filter groups. |
Object (AdvancedFilterGroup) |
|
AdvancedFilterItem
| Property |
Description |
Type |
Taxonomy |
Set this to apply a filter for a particular taxonomy value. |
Object (TaxonomyFilterItem) |
TypeFacet |
Set this to apply a filter for a particular type facet. |
Object (AdvancedTextFilter) |
Type |
Set this to apply a filter for a particular type. |
Object (AdvancedTextFilter) |
TaxonomyFilterItem
| Property |
Description |
Type |
Name |
The name of the taxonomy to filter on. This is normally the same as the filter group you see in the general search results page. |
String |
Text |
Populate this if the taxonomy is a text value. |
Object (AdvancedTextFilter) |
Number |
Populate this if the taxonomy is a number value. |
Object (AdvancedNumberFilter) |
Date |
Populate this if the taxonomy is a date value. |
Object (AdvancedDateFilter) |
AdvancedNumberFilter
| Property |
Description |
Type |
Default |
Operator |
The range operator used when comparing stored values against the filter value. Values: Equals, Exists, LessThan, GreaterThan, LessThanOrEqualTo, GreaterThanOrEqualTo. |
Enum |
Equals |
Value |
The value to filter for. It should correspond to the available filters within the general search filters. |
Float |
|
AdvancedTextFilter
| Property |
Description |
Type |
Default |
Operator |
The text operator used when comparing stored values against the filter value. Values: Equals, Exists, StartsWith. |
Enum |
Equals |
Value |
The value to filter for. It should correspond to the available filters within the general search filters. |
String |
|
AdvancedDateFilter
| Property |
Description |
Type |
Default |
Operator |
The range operator used when comparing stored values against the filter value. Values: Equals, Exists, LessThan, GreaterThan, LessThanOrEqualTo, GreaterThanOrEqualTo. |
Enum |
Equals |
Value |
The value to filter for. It should correspond to the available filters within the general search filters. |
String |
|