> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# maxFacetHits

> Maximum number of facet values to retrieve when searching for facet values

export const Setting = ({type, default: defaultValue, defaultNote, scope, min, max, formerly}) => {
  const renderedDefault = defaultValue === '' ? '""' : defaultValue;
  const renderedNote = defaultNote ? `(${defaultNote})` : '';
  return <ul>
      <li><strong>Type:</strong> <code>{type}</code></li>
      <li><strong>Default:</strong> <code>{renderedDefault}</code>{renderedNote}</li>
      {min && <li><strong>Min:</strong> <code>{min}</code></li>}
      {max && <li><strong>Max:</strong> <code>{max}</code></li>}
      <li><strong>Scope:</strong> <a href="/doc/api-reference/api-parameters"><code>{scope}</code></a></li>
      {formerly && <li>
          <strong>Deprecated name:</strong> <code>{formerly}</code>
        </li>}
    </ul>;
};

<Setting type="integer" default="10" scope="settings,search" min="1" max="100" />

## Usage

* Only applies to [`searchForFacetValues`](/doc/rest-api/search/search-for-facet-values) operations.
* To change the number of retrieved facet values for a regular search, see [`maxValuesPerFacet`](/doc/api-reference/api-parameters/maxValuesPerFacet).

## Example

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen="true">
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SetSettingsAsync(
        "INDEX_NAME",
        new IndexSettings { MaxFacetHits = 10 }
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.setSettings(
        indexName: "INDEX_NAME",
        indexSettings: IndexSettings(
          maxFacetHits: 10,
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SetSettings(client.NewApiSetSettingsRequest(
        "INDEX_NAME",
        search.NewEmptyIndexSettings().SetMaxFacetHits(10)))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setMaxFacetHits(10));
      ```

      ```js JavaScript theme={"system"}
      const response = await client.setSettings({ indexName: 'theIndexName', indexSettings: { maxFacetHits: 10 } });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(maxFacetHits = 10),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->setSettings(
          'INDEX_NAME',
          ['maxFacetHits' => 10,
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.set_settings(
          index_name="INDEX_NAME",
          index_settings={
              "maxFacetHits": 10,
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.set_settings("INDEX_NAME", Algolia::Search::IndexSettings.new(max_facet_hits: 10))
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(
            maxFacetHits = Some(10)
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response = try await client.setSettings(
          indexName: "INDEX_NAME",
          indexSettings: IndexSettings(maxFacetHits: 10)
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      index.SearchForFacetValue(new SearchForFacetRequest
      {
          FacetName = "category",
          FacetQuery = "phone",
          SearchParameters = new Query("query") { MaxFacetHits = 5 }
      });
      ```

      ```go Go theme={"system"}
      res, err := index.SearchForFacetValues(
      	"category",
      	"phone",
      	opt.MaxFacetHits(5),
      )
      ```

      ```java Java theme={"system"}
      index.searchForFacetValues(new SearchForFacetRequest()
              .setFacetQuery("category")
              .setFacetName("phone")
              .setSearchParameters(new Query().setMaxFacetHits(5L)));
      ```

      ```js JavaScript theme={"system"}
      index
        .search("query", {
          maxFacetHits: 5,
        })
        .then(({ hits }) => {
          console.log(hits);
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val query = query("query") {
          maxFacetHits = 5
      }

      index.search(query)
      ```

      ```php PHP theme={"system"}
      $facetValues = $index->searchForFacetValues("category", "phone", [
        'maxFacetHits' => 5
      ]);
      ```

      ```python Python theme={"system"}
      facet_values = index.search_for_facet_values("category", "phone", {"maxFacetHits": 5})
      ```

      ```ruby Ruby theme={"system"}
      facet_values = index.search_for_facet_values(
        "category",
        "phone",
        {
          maxFacetHits: 5
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        search into "myIndex" facet "category" values "phone" query Query(
          maxFacetHits = Some(5)
        )
      }
      ```

      ```swift Swift theme={"system"}
      let query = Query("query")
        .set(\.maxFacetHits, to: 5)

      index.search(query: query) { result in
        if case .success(let response) = result {
          print("Response: \(response)")
        }
      }
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>
