Retrieves a Recommend rule that you previously created in the Algolia dashboard.
Required ACL:Documentation Index
Fetch the complete documentation index at: https://algolia.com/llms.txt
Use this file to discover all available pages before exploring further.
settingsYour 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.
Name of the index on which to perform the operation.
"ALGOLIA_INDEX_NAME"
related-products, bought-together, trending-facets, trending-items Unique record identifier.
"test-record-123"
OK
Recommend rule.
Rule metadata.
Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
Effect of the rule.
Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
"Boost on-sale items"
Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
Unique identifier of a rule object.
Time periods when the rule is active.