POST /1/indexes/{indexName}/{model}/recommend/rules/search

Searches for Recommend rules.

Use an empty query to list all rules for this recommendation scenario.

Servers

https://{appId}.algolianet.com
https://{appId}-1.algolianet.com
https://{appId}-2.algolianet.com
https://{appId}-3.algolianet.com
https://{appId}-dsn.algolianet.com

Path parameters

Name Type Required Description

indexName

String

Yes

Name of the index on which to perform the operation.

model

String

Yes

Recommend model.

Possible values:

"related-products"
"trending-items"
"trending-facets"
"bought-together"

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`page`	Integer	No	Requested 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.
`filters`	String	No	Filter expression. This only searches for rules matching the filter expression.
`query`	String	No	Search query.
`facets[]`	Array	No	Include facets and facet values in the response. Use `['*']` to include all facets.
`context`	String	No	Only search for rules with matching context.
`hitsPerPage`	Integer	No	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. Default value: 20
`enabled`	Boolean	No	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.
`maxValuesPerFacet`	Integer	No	Maximum number of values to return for each facet.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.