Tool to search for values of a specified facet attribute. Use when you need to find specific facet values that match a query string. Facet values are sorted by decreasing count by default.
paramsstringSearch parameters as a URL-encoded query string.
facet_nameRequiredstringFacet attribute in which to search for values. This attribute must be included in the 'attributesForFaceting' index setting with the 'searchable()' modifier.
index_nameRequiredstringName of the index on which to perform the operation.
facet_querystringText to search inside the facet's values.
max_facet_hitsintegerMaximum number of facet values to return when searching for facet values.
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.