Retrieve add-to-cart rate

Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day.

The rate is the number of add-to-cart conversion events divided by the number of tracked searches. A search is tracked if it returns a queryID (clickAnalytics is true). This differs from the response’s count, which shows the overall number of searches, including those where clickAnalytics is false.

There’s a difference between a 0 and null add-to-cart rate when clickAnalytics is enabled:

  • Null means there were no queries: since Algolia didn’t receive any events, the add-to-cart rate is null.
  • 0 mean there were queries but no add-to-cart events were received.

Usage

Required ACL: analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import "github.com/algolia/algoliasearch-client-go/v4/algolia/analytics"

client, err := analytics.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", analytics.US)
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

response, err := client.GetAddToCartRate(client.NewApiGetAddToCartRateRequest(
  "index"))
if err != nil {
  // handle the eventual error
  panic(err)
}
Did you find this page helpful?