FilteredQuery document (Data API 21.6)

A filtered query allows to filter the result of a (possibly complex) query using a (possibly complex) filter.

Example:
    query : {
        filtered_query: {
            query: {
                text_query: { fields: ["coupon_id"], search_phrase: "disabled" }
            },
            filter: {
                term_filter: {
                    field: "enabled", operator: "is", values: [ false ]
                }
            }
        }
    }
 
Property Type Constraints Description
filter Filter {BoolFilter, QueryFilter, Range2Filter, RangeFilter, TermFilter} mandatory=true, nullable=false The (possibly complex) filter object.
query Query {BoolQuery, FilteredQuery, MatchAllQuery, NestedQuery, TermQuery, TextQuery} mandatory=true, nullable=false The query object.
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.