API Reference / API Parameters / numericFilters

Feb. 26, 2019

numericFilters

Type: list of strings

Engine default: []

Parameter syntax

'numericFilters' => [
  'numeric_attribute = | != | > | >= | < | <= numeric_value',
  'attribute:lower_value TO higher_value',
  ...
]

numericFilters: [
  'numeric_attribute = | != | > | >= | < | <= numeric_value',
  'attribute:lower_value TO higher_value',
  ...
]

numericFilters: [
  'numeric_attribute = | != | > | >= | < | <= numeric_value',
  'attribute:lower_value TO higher_value',
  ...
]

'numericFilters': [
  'numeric_attribute = | != | > | >= | < | <= numeric_value',
  'attribute:lower_value TO higher_value',
  ...
]

query.numericFilters = [
  "numeric_attribute = | != | > | >= | < | <= numeric_value",
  "attribute:lower_value TO higher_value"
]

numericFilters {
    and {
        // "numeric_attribute = | != | > | >= | < | <= numeric_value"
        comparison("attribute", NumericOperator.Less, 0f)
        comparison("attribute", NumericOperator.LessOrEquals, 0f)
        comparison("attribute", NumericOperator.Equals, 0f)
        comparison("attribute", NotEquals, 0f)
        comparison("attribute", Greater, 0f)
        comparison("attribute", GreaterOrEquals, 0f)

        comparison("attribute", GreaterOrEquals, 0f, isNegated = true) // Negate a numeric filter
    }
    or {
        // "attribute:lowerBound TO upperBound"
        range("attribute", 0..10)
        range("attribute", 0f, 10f)
    }
}

.setNumericFilters(
  new JSONArray()
    .put("numeric_attribute = | != | > | >= | < | <= numeric_value")
    .put("attribute:lower_value TO higher_value")
)

.NumericFilters(@"
  numeric_attribute = | != | > | >= | < | <= numeric_value,
  attribute:lower_value TO higher_value
")

.setNumericFilters(Arrays.asList(
  "numeric_attribute = | != | > | >= | < | <= numeric_value",
  "attribute:lower_value TO higher_value",
  ...
))

opt.NumericFilter("numeric_attribute = | != | > | >= | < | <= numeric_value")
opt.NumericFilter("attribute:lower_value TO higher_value")

numericFilters = Some(Seq(
  "numeric_attribute = | != | > | >= | < | <= numeric_value",
  "attribute:lower_value TO higher_value"
))

Can be used in these methods:
search, browseObjects, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, deleteBy, searchForFacetValues search, browseObjects, deleteObjectBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, browseAsync, deleteByAsync, searchForFacetValues Search, Browse, DeleteBy, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, DeleteBy, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, delete by, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Filter on numeric attributes.

The filters parameter provides an easier to use, SQL-like syntax. We recommend using it instead of this setting.

Numeric Comparisons

Format: ${attributeName} ${operator} ${operand}
Example: inStock = 1.

Supported operators are <, <=, =, !=, >= and >, with the same semantics as in virtually all programming languages.

Numeric Range

Format: ${attributeName}:${lowerBound} TO ${upperBound}
Example: price:5.99 TO 100

${lowerBound} and ${upperBound} must be numeric. Both are inclusive.

Usage notes:

No boolean operators: You cannot use boolean operators like AND and OR.
Multiple filters: If you specify multiple filters, they are interpreted as a conjunction (AND). If you want to use a disjunction (OR), use a nested array.

Examples

Apply numeric filters filters on a search query

Copy

$results = $index->search('query', [
  'numericFilters' => [
    [
      "inStock = 1",
      "deliveryDate < 1441755506"
    ],
    "price < 1000"
  ]
]);

index.search({
  query: 'query',
  numericFilters: [
    [
      'inStock = 1',
      'deliveryDate < 1441755506'
    ],
    'price < 1000'
  ]
}).then(res => {
  // console.log(res);
});

results = index.search('query', {
    'numericFilters': [
        [
            "inStock = 1",
            "deliveryDate < 1441755506"
        ],
        "price < 1000"
    ]
})

let query = Query(query: "query")
query.numericFilters = [
  [
    "inStock = 1",
    "deliveryDate < 1441755506"
  ],
  "price < 1000"
]

index.search(query, completionHandler: { (res, error) in
  print(res)
})

index.search(
  new Query("query").setNumericFilters(
    new JSONArray()
      .put(
        new JSONArray()
          .put("inStock = 1")
          .put("deliveryDate < 1441755506")
      )
      .put("price < 1000")
  )
);

index.Search<Book>(new Query("query")
{
    NumericFilters = new List<List<string>> 
    { 
      new List<string> { "inStock = 1", "deliveryDate < 1441755506"  },
      new List<string> { "price < 1000" }
    };
});

index.search(
  new Query("query").setNumericFilters(
          Arrays.asList(
                  Arrays.asList(
                          "inStock = 1",
                          "deliveryDate < 1441755506"
                  ),
                  Collections.singletonList("price < 1000")
          )
  )
);

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    numericFilters = Some(Seq(
      Some(Seq(
        "inStock = 1",
        "deliveryDate < 1441755506"
      )),
      "price < 1000"
    ))
  )
}

val query = query("query") {
    numericFilters {
        or {
            comparison("inStock", Equals, 0f)
            comparison("deliveryDate", Less, 1441755506)
        }
        and {
            comparison("price", Less, 1000)
        }
    }
}

index.search(query)

[["inStock = 1", "deliveryDate < 1441755506"], "price < 1000"] translates as (inStock = 1 OR deliveryDate < 1441755506) AND price < 1000

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

numericFilters

About this parameter

Usage notes:

Examples

Apply numeric filters filters on a search query

Did you find this page helpful?

On this page