API Reference / API Parameters / maxFacetHits

Feb. 26, 2019

maxFacetHits

Type: integer

Engine default: 10

Parameter syntax

'maxFacetHits' => number_of_facet_hits

maxFacetHits: number_of_facet_hits

'maxFacetHits' => number_of_facet_hits

'maxFacetHits': number_of_facet_hits

"maxFacetHits": number_of_facet_hits

maxFacetHits: Int = number_of_facet_hits

new JSONObject().put("maxFacetHits", number_of_facet_hits)

IndexSettings settings = new IndexSettings();
settings.MaxFacetHits = number_of_facet_hits;

.setMaxFacetHits(number_of_facet_hits)

opt.MaxFacetHits(number_of_facet_hits)

maxFacetHits = Some(number_of_facet_hits)

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, setSettingsAsync, browseAsync, searchForFacetValues Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Maximum number of facet hits to return during a search for facet values.

If you want to change the number of retrieved facet values for a regular search, see maxValuesPerFacet.

Usage notes:

Does not apply to regular search queries.
For performance reasons, the maximum allowed number of returned values is 100. Any value outside the range [1, 100] will be rejected.

Examples

Copy

$index->setSettings([
  'maxFacetHits' => 10
]);

Copy

$facetValues = $index->searchForFacetValues("category", "phone", [
  'maxFacetHits' => 5
]);

index.searchForFacetValues(new SearchForFacetRequest()
        .setFacetQuery("category")
        .setFacetName("phone")
        .setSearchParameters(new Query().setMaxFacetHits(5L)));

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

maxFacetHits

About this parameter

Usage notes:

Examples

Set default number of facet values to return during a search for facet values.

Override default number of facet values to return during a search for facet values for the current search

Did you find this page helpful?

On this page