Retrieve the configuration

Retrieves a list of configuration objects for each index.

GET /2/config

curl

cURL

curl --request GET \
  --url https://ai-personalization.eu.algolia.com/2/config \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "features": {
    "realtime": {
      "enabled": true
    }
  },
  "indices": [
    {
      "affinities": [
        "<string>"
      ],
      "errors": [
        {
          "code": "<string>",
          "index": "<string>",
          "message": "<string>"
        }
      ],
      "index": "<string>",
      "lastUpdatedAt": "<string>",
      "source": {
        "events": {
          "addToCart": [
            {
              "name": "<string>"
            }
          ],
          "purchase": [
            {
              "name": "<string>"
            }
          ],
          "viewDetails": [
            {
              "name": "<string>"
            }
          ],
          "viewListing": [
            {
              "name": "<string>"
            }
          ]
        }
      },
      "warnings": [
        {
          "code": "<string>",
          "index": "<string>",
          "message": "<string>"
        }
      ]
    }
  ],
  "status": {
    "errors": [],
    "lastUpdatedAt": "<string>"
  }
}

Required ACL: search, browse, recommendation

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

200

application/json

OK

features · object · required

Show child attributes

indices · configurationObject · object[] · required

Show child attributes

profileType · enum<string> · required

The type of user profiles to generate.

Basic profiles are based on past behaviors, ensuring search results align with previous interests.

Available options: basic

status · object · required

Show child attributes

personalizationReRanking · enum<string>

The impact that personalization has on the re-ranking of search results.

Available options: none, low, medium, high, maximum