GET /2/conversions/purchaseRate
Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown.
By default, the analyzed period includes the last eight days, including the current day.
The rate is purchase conversion events divided by tracked searches.
A search is tracked if it returns a query ID (clickAnalytics is true).
This differs from the response's count, which includes searches where clickAnalytics is false.
There's a difference between a 0 and null purchase rate when clickAnalytics is enabled:
- Null means there were no queries. Algolia didn't receive any events, so the purchase rate is null.
- 0 means there were queries but no purchase conversion events were received.
Servers
- https://analytics.{region}.algolia.com
- https://analytics.algolia.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
endDate |
String | No |
End date of the period to analyze, in |
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. |
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.