Retrieve a composition

Retrieve a single composition in the current Algolia application.

GET /1/compositions/{compositionID}

curl

cURL

curl --request GET \
  --url https://algolia_application_id.algolia.net/1/compositions/my_composition_object_id \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "objectID": "my_composition_object_id",
  "name": "my lovely crafted composition",
  "behavior": {
    "injection": {
      "main": {
        "source": {
          "search": {
            "index": "Products",
            "params": {
              "advancedSyntax": false,
              "advancedSyntaxFeatures": [
                "exactPhrase",
                "excludeWords"
              ],
              "allowTyposOnNumericTokens": true,
              "alternativesAsExact": [
                "ignorePlurals",
                "singleWordSynonym"
              ],
              "analytics": true,
              "attributeCriteriaComputedByMinProximity": false,
              "attributesToHighlight": [
                "author",
                "title",
                "conten",
                "content"
              ],
              "attributesToRetrieve": [
                "author",
                "title",
                "content"
              ],
              "attributesToSnippet": [
                "content:80",
                "description"
              ],
              "clickAnalytics": false,
              "decompoundQuery": true,
              "disableExactOnAttributes": [
                "description"
              ],
              "disableTypoToleranceOnAttributes": [
                "sku"
              ],
              "distinct": 1,
              "enableABTest": true,
              "enablePersonalization": false,
              "enableReRanking": true,
              "enableRules": true,
              "exactOnSingleWordQuery": "attribute",
              "facetFilters": [
                [
                  "category:Book",
                  "category:-Movie"
                ],
                "author:John Doe"
              ],
              "filters": "(category:Book OR category:Ebook) AND _tags:published",
              "getRankingInfo": false,
              "highlightPostTag": "</em>",
              "highlightPreTag": "<em>",
              "ignorePlurals": [
                "ca",
                "es"
              ],
              "maxFacetHits": 10,
              "minProximity": 1,
              "minWordSizefor1Typo": 4,
              "minWordSizefor2Typos": 8,
              "naturalLanguages": [],
              "numericFilters": [
                [
                  "inStock = 1",
                  "deliveryDate < 1441755506"
                ],
                "price < 1000"
              ],
              "optionalFilters": [
                "category:Book",
                "author:John Doe"
              ],
              "optionalWords": "<string>",
              "percentileComputation": true,
              "personalizationImpact": 100,
              "queryLanguages": [
                "es"
              ],
              "queryType": "prefixLast",
              "removeStopWords": [
                "ca",
                "es"
              ],
              "removeWordsIfNoResults": "firstWords",
              "replaceSynonymsInHighlight": false,
              "responseFields": [
                "*"
              ],
              "restrictHighlightAndSnippetArrays": false,
              "restrictSearchableAttributes": [
                "title",
                "author"
              ],
              "ruleContexts": [
                "mobile"
              ],
              "snippetEllipsisText": "…",
              "synonyms": true,
              "typoTolerance": true,
              "facetingAfterDistinct": false,
              "facets": [],
              "hitsPerPage": 20,
              "maxValuesPerFacet": 100,
              "renderingContent": {
                "facetOrdering": {
                  "facets": {
                    "order": [
                      "<string>"
                    ]
                  },
                  "values": {}
                },
                "redirect": {
                  "url": "<string>"
                },
                "widgets": {
                  "banners": [
                    {
                      "image": {
                        "urls": [
                          {
                            "url": "<string>"
                          }
                        ],
                        "title": "<string>"
                      },
                      "link": {
                        "url": "<string>"
                      }
                    }
                  ]
                }
              },
              "sortFacetValuesBy": "count",
              "sumOrFiltersScores": false
            }
          }
        }
      },
      "injectedItems": [
        {
          "key": "<string>",
          "source": {
            "search": {
              "index": "Products",
              "params": {
                "advancedSyntax": false,
                "advancedSyntaxFeatures": [
                  "exactPhrase",
                  "excludeWords"
                ],
                "allowTyposOnNumericTokens": true,
                "alternativesAsExact": [
                  "ignorePlurals",
                  "singleWordSynonym"
                ],
                "analytics": true,
                "attributeCriteriaComputedByMinProximity": false,
                "attributesToHighlight": [
                  "author",
                  "title",
                  "conten",
                  "content"
                ],
                "attributesToRetrieve": [
                  "author",
                  "title",
                  "content"
                ],
                "attributesToSnippet": [
                  "content:80",
                  "description"
                ],
                "clickAnalytics": false,
                "decompoundQuery": true,
                "disableExactOnAttributes": [
                  "description"
                ],
                "disableTypoToleranceOnAttributes": [
                  "sku"
                ],
                "distinct": 1,
                "enableABTest": true,
                "enablePersonalization": false,
                "enableReRanking": true,
                "enableRules": true,
                "exactOnSingleWordQuery": "attribute",
                "facetFilters": [
                  [
                    "category:Book",
                    "category:-Movie"
                  ],
                  "author:John Doe"
                ],
                "filters": "(category:Book OR category:Ebook) AND _tags:published",
                "getRankingInfo": false,
                "highlightPostTag": "</em>",
                "highlightPreTag": "<em>",
                "ignorePlurals": [
                  "ca",
                  "es"
                ],
                "maxFacetHits": 10,
                "minProximity": 1,
                "minWordSizefor1Typo": 4,
                "minWordSizefor2Typos": 8,
                "naturalLanguages": [],
                "numericFilters": [
                  [
                    "inStock = 1",
                    "deliveryDate < 1441755506"
                  ],
                  "price < 1000"
                ],
                "optionalFilters": [
                  "category:Book",
                  "author:John Doe"
                ],
                "optionalWords": "<string>",
                "percentileComputation": true,
                "personalizationImpact": 100,
                "queryLanguages": [
                  "es"
                ],
                "queryType": "prefixLast",
                "removeStopWords": [
                  "ca",
                  "es"
                ],
                "removeWordsIfNoResults": "firstWords",
                "replaceSynonymsInHighlight": false,
                "responseFields": [
                  "*"
                ],
                "restrictHighlightAndSnippetArrays": false,
                "restrictSearchableAttributes": [
                  "title",
                  "author"
                ],
                "ruleContexts": [
                  "mobile"
                ],
                "snippetEllipsisText": "…",
                "synonyms": true,
                "typoTolerance": true
              }
            }
          },
          "position": 9,
          "length": 10,
          "metadata": {
            "hits": {
              "addItemKey": true,
              "extra": {}
            }
          }
        }
      ],
      "deduplication": {
        "positioning": "highest"
      }
    }
  },
  "description": "my lovely crafted composition that is used for X purpose",
  "sortingStrategy": {
    "Price (asc)": "products-low-to-high",
    "Price (desc)": "products-high-to-low"
  }
}

Required ACL: editSettings, 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

compositionID · string · required

Unique Composition ObjectID. Composition unique identifier.

Example:

"my_composition_object_id"

Response

200

application/json

OK

objectID · string · required

Composition unique identifier.

Example:

"my_composition_object_id"

name · string · required

Composition name.

Example:

"my lovely crafted composition"

behavior · object · required

An object containing either an injection or multifeed behavior schema, but not both.

Option 1

Option 2

Show child attributes

description · string

Composition description.

Example:

"my lovely crafted composition that is used for X purpose"

sortingStrategy · object

A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. The sorting indices MUST be related to the associated main targeted index in the composition. Each key is the label your frontend sends at runtime (for example, "Price (asc)"), and each value is the name of the index that should be queried when that label is selected.

When a request includes a "sortBy" parameter, the platform looks up the corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced with the sorting strategy index it is mapped to.

Up to 20 sorting strategies can be defined.

Show child attributes

Example:

{
  "Price (asc)": "products-low-to-high",
  "Price (desc)": "products-high-to-low"
}