Searches for Recommend rules.
Use an empty query to list all rules for this recommendation scenario. 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 Recommend rules parameters.
Only search for rules with matching context.
"mobile"
Whether to only show rules where the value of their enabled property matches this parameter.
If absent, show all rules, regardless of their enabled property.
Include facets and facet values in the response. Use ['*'] to include all facets.
Facet name for rule objects or * as wildcard character.
["*"]Filter expression. This only searches for rules matching the filter expression.
"objectID:rr-123456"
Maximum number of hits per page.
Algolia uses page and hitsPerPage to control how search results are displayed (paginated).
hitsPerPage: sets the number of search results (hits) displayed per page.page: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is page=0, the second is page=1, and so on.For example, to display 10 results per page starting from the third page, set hitsPerPage to 10 and page to 2.
1 <= x <= 1000Maximum number of values to return for each facet.
1 <= x <= 1000Requested page of the API response.
Algolia uses page and hitsPerPage to control how search results are displayed (paginated).
hitsPerPage: sets the number of search results (hits) displayed per page.page: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is page=0, the second is page=1, and so on.For example, to display 10 results per page starting from the third page, set hitsPerPage to 10 and page to 2.
x >= 0Search query.