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

{
  "indices": [
    {
      "index": "<string>",
      "affinities": [
        "<string>"
      ],
      "source": {
        "type": "insights",
        "events": {
          "viewDetails": [
            {
              "type": "view",
              "name": "<string>",
              "subtype": "addToCart"
            }
          ],
          "viewListing": [
            {
              "type": "view",
              "name": "<string>",
              "subtype": "addToCart"
            }
          ],
          "addToCart": [
            {
              "type": "view",
              "name": "<string>",
              "subtype": "addToCart"
            }
          ],
          "purchase": [
            {
              "type": "view",
              "name": "<string>",
              "subtype": "addToCart"
            }
          ]
        }
      },
      "errors": [
        {
          "code": "<string>",
          "index": "<string>",
          "message": "<string>"
        }
      ],
      "warnings": [
        {
          "code": "<string>",
          "index": "<string>",
          "message": "<string>"
        }
      ],
      "lastUpdatedAt": "<string>"
    }
  ],
  "profileType": "basic",
  "status": {
    "type": "pending",
    "errors": [
      "blocked"
    ],
    "lastUpdatedAt": "<string>"
  },
  "features": {
    "realtime": {
      "enabled": true
    }
  },
  "personalizationReRanking": "none"
}

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

indices · configurationObject · object[] · required

Show child attributes

indices. index · string · required

indices. affinities · string[] · required

indices. source · source · object · required

Show child attributes

indices.source. type · enum<string>

Available options: insights

indices.source. events · object

Show child attributes

indices.source.events. viewDetails · object[] · required

Show child attributes

indices.source.events.viewDetails. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.viewDetails. name · string · required

indices.source.events.viewDetails. subtype · enum<string>

Available options: addToCart, purchase

indices.source.events. viewListing · object[] · required

Show child attributes

indices.source.events.viewListing. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.viewListing. name · string · required

indices.source.events.viewListing. subtype · enum<string>

Available options: addToCart, purchase

indices.source.events. addToCart · object[] · required

Show child attributes

indices.source.events.addToCart. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.addToCart. name · string · required

indices.source.events.addToCart. subtype · enum<string>

Available options: addToCart, purchase

indices.source.events. purchase · object[] · required

Show child attributes

indices.source.events.purchase. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.purchase. name · string · required

indices.source.events.purchase. subtype · enum<string>

Available options: addToCart, purchase

indices. errors · object[] · required

Show child attributes

indices.errors. code · string · required

indices.errors. index · string · required

indices.errors. message · string · required

indices. warnings · object[] · required

Show child attributes

indices.warnings. code · string · required

indices.warnings. index · string · required

indices.warnings. message · string · required

indices. lastUpdatedAt · string · required

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

status. type · enum<string>

Available options: pending, active, paused

status. errors · enum<string>[]

Available options: blocked, deleted, no_perso_access, all_attr_value_filtered, missing_index, no_events_last_30_days, pending_pipelines, invalid_config, all_facets_invalid

status. lastUpdatedAt · string

features · object · required

Show child attributes

features. realtime · object

Show child attributes

features.realtime. enabled · boolean

Whether the realtime personalization feature is enabled.

personalizationReRanking · enum<string>

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

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