GET /2/conversions/revenue
Retrieves revenue-related metrics, such as the total revenue or the average order value.
To retrieve revenue-related metrics, send purchase events. By default, the analyzed period includes the last eight days including the current day.
Revenue is based on purchase conversion events (a conversion event with an eventSubtype attribute of purchase).
The revenue is the price attribute multiplied by the quantity attribute for each object in the event's objectData array.
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.