Sep 20, 2024
Retrieve revenue data
Retrieves revenue-related metrics, such as the total revenue or the average order value.
To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.
Usage
Required ACL:
analytics
Copy
1
2
3
4
5
6
import { algoliasearch } from 'algoliasearch';
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initAnalytics({ region: 'us' });
const response = await client.getRevenue({ index: 'index' });
Did you find this page helpful?