Skip to main content
GET
/
1
/
configs
curl
curl --request GET \
  --url https://query-suggestions.us.algolia.com/1/configs \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
[
  {
    "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": [
      "<string>"
    ],
    "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.

Response

OK

​
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 length: 1
​
languages
required

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

Languages for which to deduplicate singular and plural forms.

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.

⌘I