Tool to search for Recommend rules in the specified index and model. Use when you need to retrieve rules matching a query, or use an empty query to list all rules for this recommendation scenario.
pageintegerRequested page of the API response. Page numbering starts at 0.
modelRequiredstringRecommend model type (related-products, bought-together, trending-facets, or trending-items).
querystringSearch query to filter rules. Use an empty string to list all rules for this recommendation scenario.
facetsarrayInclude facets and facet values in the response. Use ['*'] to include all facets.
contextstringOnly search for rules with matching context.
enabledbooleanWhether to only show rules where the value of their enabled property matches this parameter. If absent, show all rules, regardless of their enabled property.
filtersstringFilter expression. This only searches for rules matching the filter expression.
index_nameRequiredstringName of the index on which to perform the operation.
hitsPerPageintegerMaximum number of hits per page (1-1000). Algolia uses page and hitsPerPage to control how search results are displayed.
maxValuesPerFacetintegerMaximum number of values to return for each facet (1-1000).
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.