Skip to main content
GET
/
1
/
compositions
/
{compositionID}
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'
{
  "objectID": "my_composition_object_id",
  "name": "my lovely crafted composition",
  "description": "my lovely crafted composition that is used for X purpose",
  "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,
              "sortFacetValuesBy": "count",
              "sumOrFiltersScores": false
            }
          }
        }
      },
      "injectedItems": [
        {
          "key": "<string>",
          "source": {
            "search": {
              "index": "Products",
              "params": {
                "advancedSyntax": true,
                "advancedSyntaxFeatures": [
                  "<any>"
                ],
                "allowTyposOnNumericTokens": true,
                "alternativesAsExact": [
                  "<any>"
                ],
                "analytics": true,
                "attributeCriteriaComputedByMinProximity": true,
                "attributesToHighlight": [
                  "author",
                  "title",
                  "conten",
                  "content"
                ],
                "attributesToRetrieve": [
                  "author",
                  "title",
                  "content"
                ],
                "attributesToSnippet": [
                  "content:80",
                  "description"
                ],
                "clickAnalytics": true,
                "decompoundQuery": true,
                "disableExactOnAttributes": [
                  "description"
                ],
                "disableTypoToleranceOnAttributes": [
                  "sku"
                ],
                "distinct": 1,
                "enableABTest": true,
                "enablePersonalization": true,
                "enableReRanking": true,
                "enableRules": true,
                "exactOnSingleWordQuery": "attribute",
                "facetFilters": [
                  [
                    "category:Book",
                    "category:-Movie"
                  ],
                  "author:John Doe"
                ],
                "filters": "(category:Book OR category:Ebook) AND _tags:published",
                "getRankingInfo": true,
                "highlightPostTag": "<string>",
                "highlightPreTag": "<string>",
                "ignorePlurals": [
                  "ca",
                  "es"
                ],
                "maxFacetHits": 99,
                "minProximity": 4,
                "minWordSizefor1Typo": 123,
                "minWordSizefor2Typos": 123,
                "naturalLanguages": [
                  "<any>"
                ],
                "numericFilters": [
                  [
                    "inStock = 1",
                    "deliveryDate < 1441755506"
                  ],
                  "price < 1000"
                ],
                "optionalFilters": [
                  "category:Book",
                  "author:John Doe"
                ],
                "optionalWords": "<string>",
                "percentileComputation": true,
                "personalizationImpact": 50,
                "queryLanguages": [
                  "es"
                ],
                "queryType": "prefixLast",
                "removeStopWords": [
                  "ca",
                  "es"
                ],
                "removeWordsIfNoResults": "firstWords",
                "replaceSynonymsInHighlight": true,
                "responseFields": [
                  "<any>"
                ],
                "restrictHighlightAndSnippetArrays": true,
                "restrictSearchableAttributes": [
                  "title",
                  "author"
                ],
                "ruleContexts": [
                  "mobile"
                ],
                "snippetEllipsisText": "<string>",
                "synonyms": true,
                "typoTolerance": true
              }
            }
          },
          "position": 9,
          "length": 10,
          "metadata": {
            "hits": {
              "addItemKey": true,
              "extra": {}
            }
          }
        }
      ],
      "deduplication": {
        "positioning": "highest"
      }
    }
  }
}
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.

Example:

"my_composition_object_id"

Response

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
​
description
string

Composition description.

Example:

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

⌘I