GuidesAPI Reference
Guides

JSON Schema

Config

Filter

The top level filter group that you want to apply

  • Type: Object (See: AdvancedFilterGroup)

AdvancedFilterGroup

Mode

Choose if All or Any Items/Groups need to match for this group filter to be satisfied

  • Type: Enum
  • Values: All, Any, NotAll
  • Default: All

Items

A collection of filter items for this group. If multiple properties of any individual filter item are populated, then they must all be matched for the filter item to be satisfied.

  • Type: Object (See: AdvancedFilterItem)

Groups

A collection of child filter groups

  • Type: Object (See: AdvancedFilterGroup)

AdvancedFilterItem

Taxonomy

Set this to apply a filter for a particular taxonomy value

  • Type: Object (See: TaxonomyFilterItem)

TypeFacet

Set this to apply a filter for a particular type facet

  • Type: Object (See: AdvancedTextFilter)

Type

Set this to apply a filter for a particular type

  • Type: Object (See: AdvancedTextFilter)

TaxonomyFilterItem

Name

The name of the taxonomy that you want to filter on. The name normally is the same as the filter group that you see in the general search results page.

  • Type: String

Text

If the taxonomy is a text value, then you should populate this

  • Type: Object (See: AdvancedTextFilter)

Number

If the taxonomy is a number value, then you should populate this

  • Type: Object (See: AdvancedNumberFilter)

Date

If the taxonomy is a date value, then you should populate this

  • Type: Object (See: AdvancedDateFilter)

AdvancedNumberFilter

Operator

The range operator that you want to use when comparing stored values against the filter value

  • Type: Enum
  • Values: Equals, Exists, LessThan, GreaterThan, LessThanOrEqualTo, GreaterThanOrEqualTo
  • Default: Equals

Value

The value that you are filtering for. The value should correspond to the available filters within the general search filters

  • Type: Float

AdvancedTextFilter

Operator

The text operator that you want to use when comparing stored values against the filter value

  • Type: Enum
  • Values: Equals, Exists, StartsWith
  • Default: Equals

Value

The value that you are filtering for. The value should correspond to the available filters within the general search filters

  • Type: String

AdvancedDateFilter

Operator

The range operator that you want to use when comparing stored values against the filter value

  • Type: Enum
  • Values: Equals, Exists, LessThan, GreaterThan, LessThanOrEqualTo, GreaterThanOrEqualTo
  • Default: Equals

Value

The value that you are filtering for. The value should correspond to the available filters within the general search filters

  • Type: String

Updated 6 months ago