GET /2/searches

Returns the most popular searches. For each search, it also includes the average number of hits.

If you set the clickAnalytics query parameter to true, the response also includes

Tracked searches count. Tracked searches are Search API requests with the clickAnalytics parameter set to true. This differs from the response's count, which shows the overall number of searches, including those where clickAnalytics is false.
Click count
Click-through rate (CTR)
Conversion count
Conversion rate (CR)
Average click position

If you set the revenueAnalytics query parameter to true, the response also includes:

There's a difference between 0% rates and null rates:

Null means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null.
0% rates mean there were queries but no click or conversion events were received.

Servers

Name	Type	Required	Description
`revenueAnalytics`	Boolean	No	Whether to include metrics related to revenue events in the response. Default value: false
`endDate`	String	No	End date of the period to analyze, in `YYYY-MM-DD` format.
`limit`	Integer	No	Number of items to return. Default value: 10
`direction`	String	No	Sorting direction of the results: ascending or descending. Possible values: `"desc"` `"asc"` Default value: "asc"
`orderBy`	String	No	Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. Possible values: `"clickThroughRate"` `"searchCount"` `"conversionRate"` `"averageClickPosition"` Default value: "searchCount"
`clickAnalytics`	Boolean	No	Whether to include metrics related to click and conversion events in the response. Default value: false
`tags`	String	No	Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see Segment your analytics data.
`startDate`	String	No	Start date of the period to analyze, in `YYYY-MM-DD` format.
`index`	String	Yes	Index name.
`offset`	Integer	No	Position of the first item to return. Default value: 0

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.