Retrieve timeseries of an A/B test

Retrieves timeseries for an A/B test by its ID.

GET /3/abtests/{id}/timeseries

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/3/abtests/224/timeseries?startDate=2022-09-19&endDate=2023-01-21&metric=search_count' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "abTestID": 224,
  "variants": [
    {
      "dates": [
        {
          "date": "2025-06-15",
          "metrics": [
            [
              {
                "name": "addToCartCount",
                "updatedAt": "2025-06-15T15:06:44.400601Z",
                "value": 5,
                "pValue": 0.01
              },
              {
                "name": "clickThroughRate",
                "updatedAt": "2025-05-15T17:52:15.644906Z",
                "value": 0.20869847452125934,
                "pValue": 0.004
              },
              {
                "name": "revenue",
                "dimension": "USD",
                "updatedAt": "2025-05-15T17:52:15.644906Z",
                "value": 1200.5,
                "pValue": 0.04,
                "metadata": {
                  "winsorizedValue": 80.2
                }
              },
              {
                "name": "revenue",
                "dimension": "EUR",
                "updatedAt": "2025-05-15T17:52:15.644906Z",
                "value": 999.66,
                "pValue": 0.04,
                "metadata": {
                  "winsorizedValue": 888.8
                }
              }
            ]
          ]
        }
      ]
    }
  ]
}

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.

Path Parameters

id · integer · required

Unique A/B test identifier.

Example:

224

Query Parameters

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"

metric · enum<string>[]

List of metrics to retrieve. If not specified, all metrics are returned.

Available options: search_count, tracked_search_count, user_count, tracked_user_count, no_result_count, add_to_cart_count, purchase_count, clicked_search_count, converted_search_count, click_through_rate, conversion_rate, add_to_cart_rate, purchase_rate, average_click_position, revenue

Response

200

application/json

OK

abTestID · integer · required

Unique A/B test identifier.

Example:

224

variants · object[] · required

A/B test timeseries variants.

The first variant is your control index, typically your production index. All of the additional variants are indexes with changed settings that you want to test against the control.

Show child attributes