Retrieve revenue data

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.

Usage

1
2
3
4
5
6
7
use Algolia\AlgoliaSearch\Api\AnalyticsClient;

$client = AnalyticsClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');

$response = $client->getRevenue(
    'index',
);