Tool to retrieve the most popular searches from Algolia Analytics. Returns search queries ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue metrics. Use when analyzing search behavior and identifying trending queries.
tagsstringTags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's documentation on segmenting analytics data.
indexRequiredstringIndex name to retrieve top searches for.
limitintegerNumber of items to return. Default is 10.
offsetintegerPosition of the first item to return. Default is 0.
endDatestringEnd date of the period to analyze, in YYYY-MM-DD format.
orderBystringAttribute by which to order the response items.
directionstringSorting direction of the results.
startDatestringStart date of the period to analyze, in YYYY-MM-DD format.
clickAnalyticsbooleanWhether to include metrics related to click and conversion events in the response. When true, adds click-through rate, conversion rate, and click position metrics.
revenueAnalyticsbooleanWhether to include metrics related to revenue events in the response. When true, adds add-to-cart rate, purchase rate, and revenue metrics.
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.