Search for facet values

Searches for values of a specified facet attribute on the composition’s main source’s index.

  • By default, facet values are sorted by decreasing count. You can adjust this with the sortFacetValueBy parameter.
  • Searching for facet values doesn’t work if you have more than 65 searchable facets and searchable attributes combined.

Usage

Required ACL: search
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
import algoliasearch.api.CompositionClient
import algoliasearch.config.*

val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = Await.result(
  client.searchForFacetValues(
    compositionID = "foo",
    facetName = "brand",
    searchForFacetValuesRequest = Some(
      SearchForFacetValuesRequest(
        params = Some(
          SearchForFacetValuesParams(
            maxFacetHits = Some(10)
          )
        )
      )
    )
  ),
  Duration(100, "sec")
)
Did you find this page helpful?