Skip to main content
GET
/
1
/
compositions
/
{compositionID}
/
rules
/
{objectID}
curl
curl --request GET \
  --url https://algolia_application_id.algolia.net/1/compositions/my_composition_object_id/rules/lorem \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "objectID": "my_composition_rule_object_id",
  "conditions": [
    {
      "pattern": "{facet:genre}",
      "anchoring": "is",
      "context": "mobile",
      "filters": "genre:comedy"
    }
  ],
  "consequence": {
    "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"
        }
      }
    }
  },
  "description": "Display a promotional banner",
  "enabled": true,
  "validity": [
    {
      "from": 123,
      "until": 123
    }
  ],
  "tags": [
    "conditional"
  ]
}
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"

​
objectID
string
required

Unique identifier of a rule object.

Response

OK

​
objectID
string
required

Composition rule unique identifier.

Example:

"my_composition_rule_object_id"

​
conditions
object[]
required

Conditions that trigger a composition rule.

Maximum length: 25
​
consequence
object
required

Effect of the rule.

​
description
string

Description of the rule's purpose to help you distinguish between different rules.

Example:

"Display a promotional banner"

​
enabled
boolean
default:true

Whether the rule is active.

​
validity
object[]

Time periods when the rule is active.

​
tags
string[]

A list of tags.

Example:
["conditional"]
⌘I