Search for facet values

Required ACL: search

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

compositionID

string

required

Unique Composition ObjectID. Composition unique identifier.

Example:

"my_composition_object_id"

facetName

string

required

Facet attribute in which to search for values.

This attribute must be included in the attributesForFaceting index setting with the searchable() modifier.

Body

application/json

params

searchForFacetValuesParams · object

Show child attributes

params.query

string

default:""

Search query.

params.maxFacetHits

integer

default:10

Maximum number of facet values to return when searching for facet values.

Required range: x <= 100

params.searchQuery

Run composition parameters as object · object

Show child attributes

params.searchQuery.analytics

boolean

default:true

Whether this search will be included in Analytics.

params.searchQuery.analyticsTags

string[]

Tags to apply to the query for segmenting analytics data.

params.searchQuery.aroundLatLng

string

default:""

Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.

Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the aroundRadius and minimumAroundRadius settings. This parameter is ignored if you also specify insidePolygon or insideBoundingBox.

Example:

"40.71,-74.01"

params.searchQuery.aroundLatLngViaIP

boolean

default:false

Whether to obtain the coordinates from the request's IP address.

params.searchQuery.aroundRadius

Maximum radius for a search around a central location.

This parameter works in combination with the aroundLatLng and aroundLatLngViaIP parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.

Required range: x >= 1

params.searchQuery.aroundPrecision

default:10

Precision of a coordinate-based search in meters to group results with similar distances.

The Geo ranking criterion considers all matches within the same range of distances to be equal.

params.searchQuery.clickAnalytics

boolean

default:false

Whether to include a queryID attribute in the response The query ID is a unique identifier for a search query and is required for tracking click and conversion events.

params.searchQuery.enableABTest

boolean

default:true

Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.

params.searchQuery.enablePersonalization

boolean

default:false

Whether to enable Personalization.

params.searchQuery.enableReRanking

boolean

default:true

Whether this search will use Dynamic Re-Ranking This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

params.searchQuery.enableRules

boolean

default:true

Whether to enable composition rules.

params.searchQuery.facetFilters

Filter the search by facet values, so that only records with the same facet values are retrieved.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

[filter1, filter2] is interpreted as filter1 AND filter2.
[[filter1, filter2], filter3] is interpreted as filter1 OR filter2 AND filter3.
facet:-value is interpreted as NOT facet:value.

While it's best to avoid attributes that start with a -, you can still filter them by escaping with a backslash: facet:\-value.

Example:

[
  ["category:Book", "category:-Movie"],
  "author:John Doe"
]

params.searchQuery.facets

string[]

Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character *. To retrieve disjunctive facets lists, annotate any facets with the disjunctive modifier. For more information, see facets and disjunctive faceting for Smart Groups.

Example:

{
  "facetSpecificList": {
    "summary": "Specify which facet to retrieve with some marked as disjunctive",
    "value": [["category", "disjunctive(brand)", "price"]]
  },
  "facetAll": {
    "summary": "Retrieve all facets",
    "value": [["*"]]
  }
}

params.searchQuery.filters

string

Filter expression to only include items that match the filter criteria in the response.

You can use these filter expressions:

Numeric filters. <facet> <op> <number>, where <op> is one of <, <=, =, !=, >, >=.
Ranges. <facet>:<lower> TO <upper> where <lower> and <upper> are the lower and upper limits of the range (inclusive).
Facet filters. <facet>:<value> where <facet> is a facet attribute (case-sensitive) and <value> a facet value.
Tag filters. _tags:<value> or just <value> (case-sensitive).
Boolean filters. <facet>: true | false.

You can combine filters with AND, OR, and NOT operators with the following restrictions:

You can only combine filters of the same type with OR. Not supported: facet:value OR num > 3.
You can't use NOT with combinations of filters. Not supported: NOT(facet:value OR facet:value)
You can't combine conjunctions (AND) with OR. Not supported: facet:value OR (facet:value AND facet:value)

Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (OR, AND, NOT), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.

For more information, see Filters.

Example:

"(category:Book OR category:Ebook) AND _tags:published"

params.searchQuery.getRankingInfo

boolean

default:false

Whether the run response should include detailed ranking information.

params.searchQuery.hitsPerPage

integer

default:20

Number of hits per page.

Required range: 1 <= x <= 1000

params.searchQuery.injectedItems

object

A list of extenrally injected objectID groups into from an external source.

Show child attributes

params.searchQuery.injectedItems.{key}

object

Show child attributes

params.searchQuery.injectedItems.{key}.items

externalInjection · object[]

required

Show child attributes

params.searchQuery.injectedItems.{key}.items.objectID

string

required

An objectID injected into an external source.

params.searchQuery.injectedItems.{key}.items.metadata

object

User-defined key-values that will be added to the injected item in the response. This is identical to Hits metadata defined in Composition or Composition Rule, with the benefit of being set at runtime.

Example:

{ "my-field": "my-value" }

Example:

{
  "my-group-key": [
    {
      "objectID": "my-object-1",
      "metadata": { "my-field": "my-value" }
    },
    { "objectID": "my-object-2" }
  ]
}

params.searchQuery.insideBoundingBox

params.searchQuery.insidePolygon

number<double>[][]

Coordinates of a polygon in which to search.

Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see filtering inside polygons. This parameter is ignored if you also specify insideBoundingBox.

Required array length: 6 - 20000 elements

Example:

params.searchQuery.minimumAroundRadius

integer

Minimum radius (in meters) for a search around a location when aroundRadius isn't set.

Required range: x >= 1

params.searchQuery.naturalLanguages

enum<string>[]

ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)

Sets removeStopWords and ignorePlurals to the list of provided languages.
Sets removeWordsIfNoResults to allOptional.
Adds a natural_language attribute to ruleContexts and analyticsTags.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

params.searchQuery.numericFilters

Filter by numeric facets.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

You can use numeric comparison operators: <, <=, =, !=, >, >=. Comparisons are precise up to 3 decimals. You can also provide ranges: facet:<lower> TO <upper>. The range includes the lower and upper boundaries. The same combination rules apply as for facetFilters.

Example:

[
  ["inStock = 1", "deliveryDate < 1441755506"],
  "price < 1000"
]

params.searchQuery.optionalFilters

Filters to promote or demote records in the search results.

Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter facet:-value, matching records rank after records that don't match.

Optional filters don't work on virtual replicas.
Optional filters are applied after sort-by attributes.
Optional filters are applied before custom ranking attributes (in the default ranking).
Optional filters don't work with numeric attributes.

Example:

["category:Book", "author:John Doe"]

params.searchQuery.page

integer

default:0

Page of search results to retrieve.

Required range: x >= 0

params.searchQuery.query

string

default:""

Search query.

params.searchQuery.queryLanguages

enum<string>[]

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the removeStopWords and ignorePlurals settings. This setting also sets a dictionary for word detection in the logogram-based CJK languages. To support this, you must place the CJK language first You should always specify a query language. If you don't specify an indexing language, the search engine uses all supported languages, or the languages you specified with the ignorePlurals or removeStopWords parameters. This can lead to unexpected search results. For more information, see Language-specific configuration.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

Example:

["es"]

params.searchQuery.relevancyStrictness

integer

default:100

Relevancy threshold below which less relevant results aren't included in the results You can only set relevancyStrictness on virtual replica indices. Use this setting to strike a balance between the relevance and number of returned results.

Example:

90

params.searchQuery.ruleContexts

string[]

Assigns a rule context to the run query Rule contexts are strings that you can use to trigger matching rules.

Example:

["mobile"]

params.searchQuery.sortBy

string

default:""

Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the "sortingStrategy" mapping. For example, "Price (asc)", see Upsert Composition. At runtime, this label is used to look up the corresponding index or replica configured in "sortingStrategy", and the query is executed using that index instead of main's.

In addition to "sortingStrategy", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on "sortBy", see Composition Rules.

If no value is provided or an invalid value, no sorting strategy is applied.

Example:

"Price (asc)"

params.searchQuery.userToken

string

Unique pseudonymous or anonymous user identifier.

This helps with analytics and click and conversion events. For more information, see user token.

Example:

"test-user-123"

Response

results

object[]

Search for facet values results.

Show child attributes

results.indexName

string

required

results.facetHits

facetHits · object[]

required

Matching facet values.

Show child attributes

results.facetHits.value

string

required

Facet value.

Example:

"Mobile phone"

results.facetHits.highlighted

string

required

Highlighted attribute value, including HTML tags.

Example:

"<em>George</em> <em>Clo</em>oney"

results.facetHits.count

integer

required

Number of records with this facet value. The count may be approximated.

results.exhaustiveFacetsCount

boolean

required

Whether the facet count is exhaustive (true) or approximate (false). For more information, see Why are my facet and hit counts not accurate.

results.processingTimeMS

integer

Time the server took to process the request, in milliseconds.

Example:

20

Composition API

Authorizations

Path Parameters

Body

Response