curl --request GET \
--url https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/rules/lorem \
--header 'accept: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'{
"consequence": {
"filterPromotes": false,
"hide": [
{
"objectID": "test-record-123"
}
],
"params": {
"advancedSyntax": false,
"advancedSyntaxFeatures": [
"exactPhrase",
"excludeWords"
],
"allowTyposOnNumericTokens": true,
"alternativesAsExact": [
"ignorePlurals",
"singleWordSynonym"
],
"analytics": true,
"analyticsTags": [],
"aroundLatLng": "40.71,-74.01",
"aroundLatLngViaIP": false,
"aroundPrecision": 10,
"aroundRadius": 2,
"attributeCriteriaComputedByMinProximity": false,
"attributesToHighlight": [
"author",
"title",
"conten",
"content"
],
"attributesToRetrieve": [
"author",
"title",
"content"
],
"attributesToSnippet": [
"content:80",
"description"
],
"automaticFacetFilters": [
{
"facet": "<string>",
"disjunctive": false,
"score": 1
}
],
"automaticOptionalFacetFilters": [
{
"facet": "<string>",
"disjunctive": false,
"score": 1
}
],
"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"
],
"facetingAfterDistinct": false,
"facets": [
"*"
],
"filters": "(category:Book OR category:Ebook) AND _tags:published",
"getRankingInfo": false,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"hitsPerPage": 20,
"ignorePlurals": [
"ca",
"es"
],
"insideBoundingBox": "<string>",
"insidePolygon": [
[
47.3165,
4.9665,
47.3424,
5.0201,
47.32,
4.9
],
[
40.9234,
2.1185,
38.643,
1.9916,
39.2587,
2.0104
]
],
"length": 500,
"maxValuesPerFacet": 100,
"minimumAroundRadius": 2,
"minProximity": 1,
"minWordSizefor1Typo": 4,
"minWordSizefor2Typos": 8,
"mode": "keywordSearch",
"naturalLanguages": [],
"numericFilters": [
[
"inStock = 1",
"deliveryDate < 1441755506"
],
"price < 1000"
],
"offset": 123,
"optionalFilters": [
"category:Book",
"author:John Doe"
],
"optionalWords": "<string>",
"page": 0,
"percentileComputation": true,
"personalizationImpact": 100,
"query": {
"edits": [
{
"delete": "<string>",
"insert": "<string>"
}
],
"remove": [
"<string>"
]
},
"queryLanguages": [
"es"
],
"queryType": "prefixLast",
"ranking": [
"typo",
"geo",
"words",
"filters",
"proximity",
"attribute",
"exact",
"custom"
],
"relevancyStrictness": 90,
"removeStopWords": [
"ca",
"es"
],
"removeWordsIfNoResults": "firstWords",
"renderingContent": {
"facetOrdering": {
"facets": {
"order": [
"<string>"
]
},
"values": {}
},
"redirect": {
"url": "<string>"
},
"widgets": {
"banners": [
{
"image": {
"title": "<string>",
"urls": [
{
"url": "<string>"
}
]
},
"link": {
"url": "<string>"
}
}
]
}
},
"replaceSynonymsInHighlight": false,
"reRankingApplyFilter": [
"<unknown>"
],
"responseFields": [
"*"
],
"restrictHighlightAndSnippetArrays": false,
"restrictSearchableAttributes": [
"title",
"author"
],
"ruleContexts": [
"mobile"
],
"semanticSearch": {
"eventSources": [
"<string>"
]
},
"similarQuery": "comedy drama crime Macy Buscemi",
"snippetEllipsisText": "ā¦",
"sortFacetValuesBy": "count",
"sumOrFiltersScores": false,
"synonyms": true,
"tagFilters": [
[
"Book",
"Movie"
],
"SciFi"
],
"typoTolerance": true,
"userToken": "test-user-123"
},
"promote": [
{
"objectIDs": [
"test-record-123"
],
"position": 0
}
],
"redirect": {
"indexName": "<string>"
},
"userData": {
"settingID": "f2a7b51e3503acc6a39b3784ffb84300",
"pluginVersion": "1.6.0"
}
},
"objectID": "<string>",
"condition": {
"alternatives": false,
"context": "mobile",
"filters": "genre:comedy",
"pattern": "{facet:genre}"
},
"conditions": [
{
"alternatives": false,
"context": "mobile",
"filters": "genre:comedy",
"pattern": "{facet:genre}"
}
],
"description": "Display a promotional banner",
"enabled": true,
"scope": "<string>",
"tags": [
"<string>"
],
"validity": [
{
"from": 123,
"until": 123
}
]
}Retrieve a rule
Retrieves a rule by its ID.
curl --request GET \
--url https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/rules/lorem \
--header 'accept: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'{
"consequence": {
"filterPromotes": false,
"hide": [
{
"objectID": "test-record-123"
}
],
"params": {
"advancedSyntax": false,
"advancedSyntaxFeatures": [
"exactPhrase",
"excludeWords"
],
"allowTyposOnNumericTokens": true,
"alternativesAsExact": [
"ignorePlurals",
"singleWordSynonym"
],
"analytics": true,
"analyticsTags": [],
"aroundLatLng": "40.71,-74.01",
"aroundLatLngViaIP": false,
"aroundPrecision": 10,
"aroundRadius": 2,
"attributeCriteriaComputedByMinProximity": false,
"attributesToHighlight": [
"author",
"title",
"conten",
"content"
],
"attributesToRetrieve": [
"author",
"title",
"content"
],
"attributesToSnippet": [
"content:80",
"description"
],
"automaticFacetFilters": [
{
"facet": "<string>",
"disjunctive": false,
"score": 1
}
],
"automaticOptionalFacetFilters": [
{
"facet": "<string>",
"disjunctive": false,
"score": 1
}
],
"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"
],
"facetingAfterDistinct": false,
"facets": [
"*"
],
"filters": "(category:Book OR category:Ebook) AND _tags:published",
"getRankingInfo": false,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"hitsPerPage": 20,
"ignorePlurals": [
"ca",
"es"
],
"insideBoundingBox": "<string>",
"insidePolygon": [
[
47.3165,
4.9665,
47.3424,
5.0201,
47.32,
4.9
],
[
40.9234,
2.1185,
38.643,
1.9916,
39.2587,
2.0104
]
],
"length": 500,
"maxValuesPerFacet": 100,
"minimumAroundRadius": 2,
"minProximity": 1,
"minWordSizefor1Typo": 4,
"minWordSizefor2Typos": 8,
"mode": "keywordSearch",
"naturalLanguages": [],
"numericFilters": [
[
"inStock = 1",
"deliveryDate < 1441755506"
],
"price < 1000"
],
"offset": 123,
"optionalFilters": [
"category:Book",
"author:John Doe"
],
"optionalWords": "<string>",
"page": 0,
"percentileComputation": true,
"personalizationImpact": 100,
"query": {
"edits": [
{
"delete": "<string>",
"insert": "<string>"
}
],
"remove": [
"<string>"
]
},
"queryLanguages": [
"es"
],
"queryType": "prefixLast",
"ranking": [
"typo",
"geo",
"words",
"filters",
"proximity",
"attribute",
"exact",
"custom"
],
"relevancyStrictness": 90,
"removeStopWords": [
"ca",
"es"
],
"removeWordsIfNoResults": "firstWords",
"renderingContent": {
"facetOrdering": {
"facets": {
"order": [
"<string>"
]
},
"values": {}
},
"redirect": {
"url": "<string>"
},
"widgets": {
"banners": [
{
"image": {
"title": "<string>",
"urls": [
{
"url": "<string>"
}
]
},
"link": {
"url": "<string>"
}
}
]
}
},
"replaceSynonymsInHighlight": false,
"reRankingApplyFilter": [
"<unknown>"
],
"responseFields": [
"*"
],
"restrictHighlightAndSnippetArrays": false,
"restrictSearchableAttributes": [
"title",
"author"
],
"ruleContexts": [
"mobile"
],
"semanticSearch": {
"eventSources": [
"<string>"
]
},
"similarQuery": "comedy drama crime Macy Buscemi",
"snippetEllipsisText": "ā¦",
"sortFacetValuesBy": "count",
"sumOrFiltersScores": false,
"synonyms": true,
"tagFilters": [
[
"Book",
"Movie"
],
"SciFi"
],
"typoTolerance": true,
"userToken": "test-user-123"
},
"promote": [
{
"objectIDs": [
"test-record-123"
],
"position": 0
}
],
"redirect": {
"indexName": "<string>"
},
"userData": {
"settingID": "f2a7b51e3503acc6a39b3784ffb84300",
"pluginVersion": "1.6.0"
}
},
"objectID": "<string>",
"condition": {
"alternatives": false,
"context": "mobile",
"filters": "genre:comedy",
"pattern": "{facet:genre}"
},
"conditions": [
{
"alternatives": false,
"context": "mobile",
"filters": "genre:comedy",
"pattern": "{facet:genre}"
}
],
"description": "Display a promotional banner",
"enabled": true,
"scope": "<string>",
"tags": [
"<string>"
],
"validity": [
{
"from": 123,
"until": 123
}
]
}search operation.
Required ACL: settingsAuthorizations
Your Algolia application ID.
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
Name of the index on which to perform the operation.
"ALGOLIA_INDEX_NAME"
Unique identifier of a rule object.
Response
OK
Rule object.
Effect of the rule.
For more information, see Consequences.
Show child attributes
Show child attributes
Unique identifier of a rule object.
Legacy field for a single condition. This field is maintained for backward compatibility with older rules but should not be used in new implementations.
Show child attributes
Show child attributes
Conditions that trigger a rule.
Some consequences require specific conditions or don't require any condition. For more information, see Conditions.
25Show child attributes
Show child attributes
Description of the rule's purpose to help you distinguish between different rules.
"Display a promotional banner"
Whether the rule is active.
Time periods when the rule is active.
Show child attributes
Show child attributes
Was this page helpful?