Timeseries
GET /experiments/{testId}/timeseriesReturns each variation's metrics split into time buckets, plus the visitors across all variations. Use it to draw a chart of how an experiment moved, or to check when a result started to hold. For the current numbers rather than their history, use /summary or /results.
Parameters
testId
Path parameter. The experiment's ID, from /experiments.
mode
cumulative (default) for running totals up to each bucket, or interval for each bucket on its own.
startDate, endDate, timeZoneName
The date window. The time zone also decides where each bucket starts.
Filters
Any filter, applied before the buckets are built.
Response
mode
string
cumulative or interval, as asked for
interval
string
The bucket size as an ISO 8601 duration, P1D today
timeZoneName
string
The time zone the buckets are aligned to
period.dateRanges[]
object
The running periods the buckets cover
totalVisitors[]
object
start (string) and visitors (number | null), one per bucket
variations[].variationId
integer
The variation
variations[].name
string | null
Its name
variations[].isControl
boolean
Whether it is the control
variations[].points[]
object
start (string) plus the metrics below, each number | null, in the same order as totalVisitors
Each point's metrics: visitors, conversions, conversionRate, revenue, shippingRevenue, revenuePerVisitor, averageOrderValue, addToCarts, checkoutsStarted, checkoutsCompleted, completionRate, subscriptionOrdersPerVisitor, collectionPageViewRate, productPageViewRate, collectionToProductRate, productToCartRate, cartToCheckoutRate, exitBeforeProductRate.
Worth knowing
Read
intervalrather than assuming a day. Longer experiments may get larger buckets later, and the shape will not change.The last bucket is usually partial, ending at the end of the period or at the current moment for a running experiment. In
intervalmode its counts look lower for that reason; its rates are unaffected.A visitor counts in every bucket they were active in, so in
intervalmode the buckets add up to more than the experiment's unique visitors.cumulativemode counts each visitor once.Paused periods are not buckets. They are missing from the series, which is what
period.dateRangesdescribes.Personalizations return only the personalized variation.
Last updated