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
import { compositionClient } from '@algolia/composition';

//
const client = compositionClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

const response = await client.searchForFacetValues({
  compositionID: 'foo',
  facetName: 'brand',
  searchForFacetValuesRequest: { params: { maxFacetHits: 10 } },
});
Did you find this page helpful?