Summary
GET /experiments/{testId}/summaryReturns an experiment's headline numbers: visitors, conversions, orders, revenue and the significance status. It is the cheap half of /results and the right choice for dashboards and alerts that only need the headline.
Parameters
testId
Path parameter, from /experiments
startDate, endDate, timeZoneName
The date window
Filters
Any filter
Response
goal, currency
string | null
The metric judged, and the currency of money values
period.dateRanges[]
object
startDate and endDate of each running period covered
appliedFilters
object
The filters as the API read them, values as arrays of strings
totals.uniqueVisitors
number
Visitors across all variations
variations[].id
integer
The variation
variations[].name
string | null
Its name
variations[].isControl
boolean
Whether it is the control
variations[] metrics
number | null
uniqueVisitors, conversions, conversionRate, orders, revenue, revenuePerVisitor, averageOrderValue, addToCarts, addToCartRate, checkoutsStarted, checkoutStartRate
curl https://elevateab.app/api/external/v1/experiments/TEST_ID/summary \
-H "Authorization: Bearer YOUR_API_KEY"Worth knowing
No winner or probabilities here. For those, and for profit, sessions, discounts and lift, use
/results.The status is the one Elevate shows, computed from your store's own statistical settings, so changing the significance threshold changes what this returns.
Experiments older than our current analytics return
422. Drafts are not published by the API at all, so they return404.
Last updated