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

# sortFacetValuesBy

> Controls how facet values are sorted

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="enum<string>" default="count" scope="settings,search" />

The `sortFacetValuesBy` parameter controls the order in which facet values are returned for each facet in the response.\
This affects data returned by the [`facets`](/doc/api-reference/api-parameters/facets) parameter,
but **not** how values are displayed in the UI.

To customize display order, see [Facet value display](/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).

## Options

<ParamField path="count">
  Sort facet values by descending count (most frequent values first).
  The count is the number of records matching the query with that facet value.
  This is the default.
</ParamField>

<ParamField path="alpha">
  Sort facet values alphabetically, from A to Z.
</ParamField>

## Usage

To control how many facet values are returned, see [`maxValuesPerFacet`](/doc/api-reference/api-parameters/maxValuesPerFacet).

## Examples

### Set default sort order for facet values

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

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

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

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

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

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

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

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

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

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

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

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      IndexSettings settings = new IndexSettings();
      settings.SortFacetValuesBy = "alpha";

      index.SetSettings(settings);
      ```

      ```go Go theme={"system"}
      res, err := index.SetSettings(search.Settings{
      	SortFacetValuesBy: opt.SortFacetValuesBy("alpha"),
      })
      ```

      ```java Java theme={"system"}
      index.setSettings(
        new IndexSettings().setSortFacetValuesBy("alpha")
      );
      ```

      ```js JavaScript theme={"system"}
      index
        .setSettings({
          sortFacetValuesBy: "alpha",
        })
        .then(() => {
          // done
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val settings = settings {
          sortFacetsBy = SortFacetsBy.Alpha
      }

      index.setSettings(settings)
      ```

      ```php PHP theme={"system"}
      $index->setSettings([
        'sortFacetValuesBy': 'alpha'
      ]);
      ```

      ```python Python theme={"system"}
      index.set_settings({"sortFacetValuesBy": "alpha"})
      ```

      ```ruby Ruby theme={"system"}
      index.set_settings(
        {
          sortFacetValuesBy: "alpha"
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        setSettings of "myIndex" `with` IndexSettings(
          sortFacetValuesBy = Some("alpha")
        )
      }
      ```

      ```swift Swift theme={"system"}
      let settings = Settings()
        .set(\.sortFacetsBy, to: .alpha)

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

### Change sort order for facet values at query time

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen>
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SearchSingleIndexAsync<Hit>(
        "INDEX_NAME",
        new SearchParams(new SearchParamsObject { Query = "query", SortFacetValuesBy = "count" })
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.searchSingleIndex(
        indexName: "INDEX_NAME",
        searchParams: SearchParamsObject(
          query: "query",
          sortFacetValuesBy: "count",
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
        "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
        search.NewEmptySearchParamsObject().SetQuery("query").SetSortFacetValuesBy("count"))))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      SearchResponse response = client.searchSingleIndex(
        "INDEX_NAME",
        new SearchParamsObject().setQuery("query").setSortFacetValuesBy("count"),
        Hit.class
      );
      ```

      ```js JavaScript theme={"system"}
      const response = await client.searchSingleIndex({
        indexName: 'indexName',
        searchParams: { query: 'query', sortFacetValuesBy: 'count' },
      });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.searchSingleIndex(
          indexName = "INDEX_NAME",
          searchParams = SearchParamsObject(query = "query", sortFacetValuesBy = "count"),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->searchSingleIndex(
          'INDEX_NAME',
          ['query' => 'query',
              'sortFacetValuesBy' => 'count',
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.search_single_index(
          index_name="INDEX_NAME",
          search_params={
              "query": "query",
              "sortFacetValuesBy": "count",
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.search_single_index(
        "INDEX_NAME",
        Algolia::Search::SearchParamsObject.new(query: "query", sort_facet_values_by: "count")
      )
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.searchSingleIndex(
          indexName = "INDEX_NAME",
          searchParams = Some(
            SearchParamsObject(
              query = Some("query"),
              sortFacetValuesBy = Some("count")
            )
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response: SearchResponse<Hit> = try await client.searchSingleIndex(
          indexName: "INDEX_NAME",
          searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
              query: "query",
              sortFacetValuesBy: "count"
          ))
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      index.Search(new Query("query")
      {
          SortFacetValuesBy = "count"
      });
      ```

      ```go Go theme={"system"}
      res, err := index.Search(
        "query",
        opt.SortFacetValuesBy("count"),
      })
      ```

      ```java Java theme={"system"}
      index.search(
        new Query("query").setSortFacetValuesBy("count")
      );
      ```

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

      ```kotlin Kotlin theme={"system"}
      val query = query("query") {
          sortFacetsBy = SortFacetsBy.Count
      }

      index.search(query)
      ```

      ```php PHP theme={"system"}
      $results = $index->search('query', [
        'sortFacetValuesBy' => "count"
      ]);
      ```

      ```python Python theme={"system"}
      results = index.search("query", {"sortFacetValuesBy": "count"})
      ```

      ```ruby Ruby theme={"system"}
      results = index.search(
        "query",
        {
          sortFacetValuesBy: "count"
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        search into "myIndex" query Query(
          query = Some("query"),
          sortFacetValuesBy = Some("count")
        )
      }
      ```

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

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