FilteringBundle

The Filtering API requests reference an object of type FilteringBundle. The configuration of the bundle will vary depending on the provided inputs. The following properties define this object.

FilteringBundle Properties

• filters : List<Filter>, A list of filters. For more information see Filter Properties below.
• contentBundles : Map<Id, ContentBundle>, The returned content items. The key to the map is the content origin Id and the value is the content bundle.
• relevance : Map<Id, Integer>, A map of each content origin Id to its relevance to the search. A higher number indicates greater relevance.
• contentOrdering : Map<String, List<Id>>, A map of order type to an ordered list of origin Ids matching that order type. Possible order types:
  • PublishedDate
  • OriginalPublishedDate
  • Relevance

Filter Properties

The FilteringBundle object references an object of type Filter. The following properties define this object.

• filterType : String, The type of the filter. These correspond to the values provided for the filterGroups list parameter in the request. Possible filter types:
  • PublishedDate
  • OriginalPublishedDate
  • Taxonomy
• name : String, Name of the filter.
• message : String, Content­-specific rendering message.
• count : Integer, Number of results that matched this filter.
• children : List<FilterItem>, Filters representing subcategories of this filter. For example, a filter of OriginalPublishedDate may have a subcategory filter for items originally published today, and a separate subcategory filter for items published yesterday. For more information see FilterItem Properties below.

FilterItem Properties

The Filter object references an object of type FilterItem. The following properties define this object.

• filter : String, Description of the filter.
• originIds : Set<Id>, Origin Ids matching this filter.