API Reference / API Parameters / sortFacetValuesBy

Feb. 26, 2019

sortFacetValuesBy

Type: string

Engine default: count

Parameter syntax

'sortFacetValuesBy' => 'count'|'alpha'

sortFacetValuesBy: 'count'|'alpha'

sortFacetValuesBy: 'count'|'alpha'

'sortFacetValuesBy': 'count'|'alpha'

"sortFacetValuesBy": "count"|"alpha"

sortFacetValuesBy: SortFacetValuesBy = SortFacetValuesBy.Alpha 
| SortFacetValuesBy.Count

new JSONObject().put(
  'sortFacetValuesBy',
  'count'|'alpha'
)

IndexSettings settings = new IndexSettings();
settings.SortFacetValuesBy = "count"|"alpha";

.setSortFacetValuesBy("count"|"alpha")

opt.SortFacetValuesBy("count"|"alpha")

sortFacetValuesBy = Some("count"|"alpha")

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

Controls how facet values are sorted.

When using facets, Algolia retrieves a list of matching facet values for each faceted attribute. This parameter controls how the facet values are sorted within each faceted attribute.

Usage notes:

You can either sort by count (the default, from high to low) or alphabetically
The set of returned facet values depends on the maximum number of facet values returned, which depends on the maxValuesPerFacet setting. The default is 100 and the max is 1000. Therefore, values with very low frequency could potentially not be returned.

Options:

count: Facet values are sorted by decreasing count. The count is the number of records containing this facet value in the results of the query.
alpha: Facet values are sorted in alphabetical order, ascending from A to Z.

Examples

Copy

$index->setSettings([
  'sortFacetValuesBy': 'alpha'
]);

Copy

$results = $index->search('query', [
  'sortFacetValuesBy' => "count"
]);

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

sortFacetValuesBy

About this parameter

Usage notes:

Options:

Examples

Set default sort order for facet values

Override default sort order for facet values at query time

Did you find this page helpful?

On this page