API clients / Scala / Analytics

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
7
8
9
10
11

import algoliasearch.api.AnalyticsClient

val client = AnalyticsClient(
  appId = "ALGOLIA_APPLICATION_ID",
  apiKey = "ALGOLIA_API_KEY",
  region = Option("ALGOLIA_APPLICATION_REGION")
)

val response = client.getRevenue(
  index = "index"
)
See full API reference
Did you find this page helpful?