Retrieve a configuration

Retrieves a single Query Suggestions configuration by its index name.

GET /1/configs/{indexName}

curl

cURL

curl --request GET \
  --url https://query-suggestions.us.algolia.com/1/configs/ALGOLIA_INDEX_NAME \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

Example

{
  "appID": "<string>",
  "indexName": "ALGOLIA_INDEX_NAME",
  "sourceIndices": [
    {
      "indexName": "products",
      "replicas": false,
      "analyticsTags": [
        "<string>"
      ],
      "facets": [
        {
          "attribute": "category",
          "amount": 3
        },
        {
          "attribute": "brand",
          "amount": 2
        }
      ],
      "minHits": 5,
      "minLetters": 4,
      "generate": [
        [
          "color",
          "brand"
        ]
      ],
      "external": [
        "<string>"
      ]
    }
  ],
  "languages": false,
  "exclude": [
    "<string>"
  ],
  "enablePersonalization": false,
  "allowSpecialCharacters": false
}

Required ACL: settings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName · string · required

Query Suggestions index name. Name of the Query Suggestions index (case-sensitive).

Example:

"ALGOLIA_INDEX_NAME"

Response

200

application/json

OK

API response for retrieving Query Suggestions configurations. Query Suggestions configuration. Query Suggestions configuration.

appID · string · required

Algolia application ID to which this Query Suggestions configuration belongs.

indexName · string · required

Name of the Query Suggestions index (case-sensitive).

Example:

"ALGOLIA_INDEX_NAME"

sourceIndices · object[] · required

Algolia indices from which to get the popular searches for query suggestions.

Minimum array length: 1

Show child attributes

sourceIndices. indexName · string · required

Name of the Algolia index (case-sensitive) to use as source for query suggestions.

Example:

"products"

sourceIndices. replicas · boolean · default: false

If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.

Example:

false

sourceIndices. analyticsTags · string[] | null

Analytics tags for filtering the popular searches. For more information, see Segment your analytics data.

sourceIndices. facets · facets · object[] | null

Facets to use as top categories with your suggestions.

If provided, Query Suggestions adds the top facet values to each suggestion.

Show child attributes

sourceIndices.facets. attribute · string

Facet name.

sourceIndices.facets. amount · integer

Number of suggestions.

Example:

[
  { "attribute": "category", "amount": 3 },
  { "attribute": "brand", "amount": 2 }
]

sourceIndices. minHits · integer · default: 5

Minimum number of hits required to be included as a suggestion.

A search query must at least generate minHits search results to be included in the Query Suggestions index.

Required range: x >= 0

sourceIndices. minLetters · integer · default: 4

Minimum letters required to be included as a suggestion.

A search query must be at least minLetters long to be included in the Query Suggestions index.

Required range: x >= 0

sourceIndices. generate · string[][] | null

Facets used for generating query suggestions from facet values.

For example, if you set generate: ["color", "brand"], combinations from the facet values are added as query suggestions, such as "blue adidas", "red adidas", "blue nike", "red nike", etc.

You can include nested lists.

Example:

[["color", "brand"]]

sourceIndices. external · string[] | null

Algolia indices with popular searches to use as query suggestions.

Records of these indices must have these attributes:

• query: search query which will be added as a suggestion
• count: measure of popularity of that search query

For example, you can export popular searches from an external analytics provider, such as Google Analytics or Adobe Analytics, and feed this data into an Algolia index. You can use this index to generate query suggestions until your Algolia Analytics has collected enough data.

languages · required

Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.

Two-letter country code.

exclude · string[] | null · required

Words or regular expressions to exclude from the suggestions.

enablePersonalization · boolean · default: false · required

Whether to turn on personalized query suggestions.

allowSpecialCharacters · boolean · default: false · required

Whether to include suggestions with special characters.