GET /2/hits
Retrieves the object IDs of the 1,000 most frequent search results.
If you set the clickAnalytics query parameter to true, the response also includes:
- Tracked searches count. Tracked searches are Search API requests with the
clickAnalyticsparameter set totrue. This differs from the response'scount, which shows the overall number of searches, including those whereclickAnalyticsisfalse. - Click count
- Click-through rate (CTR)
- Conversion count
- Conversion rate (CR)
- Average click position
If you set the revenueAnalytics parameter to true, the response also includes:
- Add-to-cart count
- Add-to-cart rate (ATCR)
- Purchase count
- Purchase rate
- Revenue details for each currency
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
- https://analytics.{region}.algolia.com
- https://analytics.algolia.com
Query parameters
| 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 |
limit |
Integer | No |
Number of items to return. Default value: 10 |
search |
String | No |
Search query. |
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 |
startDate |
String | No |
Start date of the period to analyze, in |
index |
String | Yes |
Index name. |
offset |
Integer | No |
Position of the first item to return. Default value: 0 |
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.