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.

GET /2/conversions/addToCartRate

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/2/conversions/addToCartRate?index=ALGOLIA_INDEX_NAME&startDate=2022-09-19&endDate=2023-01-21&tags=device%3Amobile%2520phone' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "rate": 0.1,
  "trackedSearchCount": 2,
  "addToCartCount": 10,
  "dates": [
    {
      "rate": 0.1,
      "trackedSearchCount": 2,
      "addToCartCount": 10,
      "date": "2023-06-14"
    }
  ]
}

Required ACL: analytics

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

index · string · required

Index name.

Example:

"ALGOLIA_INDEX_NAME"

startDate · string

Start date of the period to analyze, in YYYY-MM-DD format.

Example:

"2022-09-19"

endDate · string

End date of the period to analyze, in YYYY-MM-DD format.

Example:

"2023-01-21"

tags · string

Tags by which to segment the analytics.

You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.

Response

200

application/json

OK

rate · number<double> | null · required

Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with clickAnalytics set to true.

Required range: 0 <= x <= 1

Example:

0.1

trackedSearchCount · integer · default: 0 · required

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Example:

2

addToCartCount · integer · default: 0 · required

Number of add-to-cart events from this search.

Required range: x >= 0

Example:

10

dates · dailyAddToCartRates · object[] · required

Daily add-to-cart rates.

Show child attributes

dates. rate · number<double> | null · required

Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with clickAnalytics set to true.

Required range: 0 <= x <= 1

Example:

0.1

dates. trackedSearchCount · integer · default: 0 · required

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Example:

2

dates. addToCartCount · integer · default: 0 · required

Number of add-to-cart events from this search.

Required range: x >= 0

Example:

10

dates. date · string · required

Date in the format YYYY-MM-DD.

Example:

"2023-06-14"