SearchBlox

SearchBlox Developer Documentation

Welcome to the SearchBlox developer documentation. Here you will find comprehensive technical documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides

Search Parameters

SearchBlox supports a wide array of search parameters. These parameters can be provided in the search API URL and in the faceted search parameters.

Facet Filter Request Parameters

  • New search API supports a list of facet filter parameters, these parameters are used in SearchBlox faceted search pages for facet filters and also can be used in customized searches.
  • To learn more on faceted search filter read: Facets Set up

Sample Search URLs with Facet Search Parameters

Sample search URLs with parameters for New Search API:

Sample New Search API URL with basic parameters

https://localhost:8443/searchblox/rest/v2/api/search?pretty=true&col=1&query=*&facet.field=keywords&f.keywords.filter=africa

Parameter

Default Value

Range of Values

Description

facet

on

on

Enable facets

facet.field

No default field

Any standard or custom field including term, number or date fields

Provides the ability to facet on any field

facet.field.filter

No default field

Possible values of the meta field to be filtered

The facet value of the meta field that is used to filter the results

facet.field.notfilter

No default field

Possible values of the meta field not to be filtered

The facet value of the meta field that is to be excluded in search results

f.{fieldname}.size

10

1-1000

Sets the number of values returned

f.{numericalFieldName}.range

No default field

Examples of range [TO100000], [1000TO100000], [100TO]

Sets of range of size for size field filtering

f.{numericalFieldName}.filter

No default field

Possible values of size ranges (as in range above) to be filtered

Possible size value to filter search results

f.{numericalFieldName}.range.notfilter

No default field

Possible values of size ranges (as in range above) not to be filtered

Possible size value to exclude in search results

f.{datefieldname}.range

No default field

Examples of date ranges [*TO2012-02-28T00:00:26], [2010-02-28T00:00:26TO2012-02-28T00:00:26]

Sets the range of dates for the date field filtering

f.{datefieldname}.interval

No default field

Possible values are minute, hour, day, week, month, quarter, year

Sets the date histogram period for date field faceting

f.{datefieldname}.filter

No default field

Possible values of date ranges (as in range above) to be filtered

Possible date values to be filtered

f.{datefieldname}.range.notfilter

No default field

Possible values of date ranges that is not to be filtered

Possible date values to be excluded

Sample Search Query URLs with Parameters

Filter parameter

Default Boolean operator

Facet Filters

Single Facet

Multiple Facets

Date Facets

Customized Date Facet

Pre-defined Date Facet

👍

General Information

  • Facet filters are AND filters.
  • Normal Filters can be used with AND as well as OR.
  • Facet filters can only be given in URL.
  • Filters can be given as a URL parameter or as fielded search.
  • Use default=AND to enable AND search.
  • View results in JSON using &debug=true

Updated 4 months ago


Search Parameters


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.