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

variants. dates · object[]

Show child attributes

variants.dates. date · string

Date where the metric was updated, in RFC 3339 format.

Example:

"2025-06-15"

variants.dates. metrics · object[]

All ABTest metrics that were defined during test creation.

Show child attributes

variants.dates.metrics. name · string · required

variants.dates.metrics. updatedAt · string · required

Date and time when the metric was last updated, in RFC 3339 format.

variants.dates.metrics. value · number<double> · required

variants.dates.metrics. pValue · number<double> · required

PValue for the first variant (control) will always be 0. For the other variants, pValue is calculated for the current variant based on the control.

variants.dates.metrics. valueCIHigh · number<double>

The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).

variants.dates.metrics. valueCILow · number<double>

The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).

variants.dates.metrics. dimension · string

Dimension defined during test creation.

variants.dates.metrics. metadata · object

Metric specific metadata.

Show child attributes

variants.dates.metrics.metadata. winsorizedValue · number<double>

Only present in case the metric is 'revenue'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).

variants.dates.metrics.metadata. mean · number<double>

Mean value for this metric.

Example:

53.7

Example:

{ "winsorizedValue": 888.8, "mean": 53.7 }

variants.dates.metrics. criticalValue · number<double>

The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.

variants.dates.metrics. significant · boolean

Whether the pValue is significant or not based on the critical value and the error correction algorithm used.