Retrieving facets

To retrieve facets and their respective counts as part of the JSON response, you must specify a list of facets in the facets parameter at query time.

For example, you can retrieve your books’ facets with the search method, and the facets parameter.

When the facets parameter is empty, the engine returns no facet information.

C#

await client.search({
  requests: [
    {
      indexName: '<YOUR_INDEX_NAME>',
      query: '<YOUR_QUERY>',
      facets: ['author', 'genre'],
    },
  ],
});

To extract all facet information, you can use a wildcard (*).

await client.search({
  requests: [
    {
      indexName: '<YOUR_INDEX_NAME>',
      query: '<YOUR_QUERY>',
      facets: ['*'],
    },
  ],
});

Dart

$client->search([
    'requests' => [
        [
            'indexName' => '<YOUR_INDEX_NAME>',
            'query' => '<YOUR_QUERY>',
            'facets' => ['author', 'genre'],
        ],
    ],
]);

To extract all facet information, you can use a wildcard (*).

$client->search([
    'requests' => [
        [
            'indexName' => '<YOUR_INDEX_NAME>',
            'query' => '<YOUR_QUERY>',
            'facets' => ['*'],
        ],
    ],
]);

Go

import com.algolia.model.search.*;

client.search(
  new SearchMethodParams()
    .addRequests(
      new SearchForHits()
        .setIndexName("<YOUR_INDEX_NAME>")
        .setQuery("<YOUR_QUERY>")
        .addFacets("author")
        .addFacets("genre")
    )
);

To extract all facet information, you can use a wildcard (*).

import com.algolia.model.search.*;

client.search(
  new SearchMethodParams()
    .addRequests(
      new SearchForHits()
        .setIndexName("<YOUR_INDEX_NAME>")
        .setQuery("<YOUR_QUERY>")
        .addFacets("*")
    )
);

Java

import com.algolia.model.search.*;

client.search(
    searchMethodParams = SearchMethodParams(
        requests = listOf(
            SearchForHits(
                indexName = "<YOUR_INDEX_NAME>",
                query = "<YOUR_QUERY>",
                facets = listOf("author", "genre"),
            )
        )
    )
)

To extract all facet information, you can use a wildcard (*).

import com.algolia.model.search.*;

client.search(
    searchMethodParams = SearchMethodParams(
        requests = listOf(
            SearchForHits(
                indexName = "<YOUR_INDEX_NAME>",
                query = "<YOUR_QUERY>",
                facets = listOf("*"),
            )
        )
    )
)

JavaScript

await client.search(
  searchMethodParams: SearchMethodParams(
    requests: [
      SearchForHits(
        indexName: "<YOUR_INDEX_NAME>",
        query: "<YOUR_QUERY>",
        facets: ["author", "genre"],
      ),
    ],
  ),
);

Kotlin

import (
  "github.com/algolia/algoliasearch-client-go/v4/algolia/search"
)

indexName := "<INDEX_NAME>"
appID := "<APPLICATION_ID>"
apiKey := "<API_KEY>"

searchClient, _ := search.NewClient(appID, apiKey)

results, err := searchClient.Search(
  searchClient.NewApiSearchRequest(
    search.NewSearchMethodParams(
      []search.SearchQuery{
        search.SearchForHitsAsSearchQuery(
          search.NewSearchForHits(
            indexName,
            search.WithSearchForHitsFacets([]string{"author", "genre"}),
          ),
        ),
      },
    ),
  ),
)
if err != nil {
  panic(err)
}

To extract all facet information, you can use a wildcard (*).

import (
  "github.com/algolia/algoliasearch-client-go/v4/algolia/search"
)

indexName := "<INDEX_NAME>"
appID := "<APPLICATION_ID>"
apiKey := "<API_KEY>"

searchClient, _ := search.NewClient(appID, apiKey)

results, err := searchClient.Search(
  searchClient.NewApiSearchRequest(
    search.NewSearchMethodParams(
      []search.SearchQuery{
        search.SearchForHitsAsSearchQuery(
          search.NewSearchForHits(
            indexName,
            search.WithSearchForHitsFacets([]string{"*"}),
          ),
        ),
      },
    ),
  ),
)
if err != nil {
  panic(err)
}

PHP

using Algolia.Search.Clients;
using Algolia.Search.Models.Search;

var client = new SearchClient("<YOUR_APP_ID>", "<YOUR_API_KEY>");
await client.SearchSingleIndexAsync<Actor>("YOUR_INDEX_NAME", new SearchParams(new SearchParamsObject
{
  Facets = ["author", "genre"]
}));

To extract all facet information, you can use a wildcard (*).

using Algolia.Search.Clients;
using Algolia.Search.Models.Search;

var client = new SearchClient("<YOUR_APP_ID>", "<YOUR_API_KEY>");
await client.SearchSingleIndexAsync<Actor>("YOUR_INDEX_NAME", new SearchParams(new SearchParamsObject
{
  Facets = ["*"]
}));