Segments
GET /experiments/{testId}/segments/{view}Returns the experiment's results split by visitor segment, so you can see where a change worked and where it did not. Four views return the same shape with different metrics.
summary
How did each segment convert and earn?
checkout
Where did checkouts stall, and how were discounts used?
browsing
How did visitors move from collections to products to the cart?
subscriptions
How did subscription orders and revenue differ?
Parameters
testId
Path parameter, from /experiments
view
summary, checkout, browsing or subscriptions
startDate, endDate, timeZoneName
The date window
Filters
Any filter, applied before the split
Response
view
string
The view you asked for
segments[].dimension
string
device, user_type, traffic_source or source_channels
segments[].name
string
The segment, such as MOBILE, new_visitors or google
segments[].visitors
object
control, variations and total, each number | null
segments[].variations[]
object
variationId (integer), isControl (boolean), lift (number | null) and the view's metrics, each number | null
The summary view's metrics are visitors, conversions, conversionRate, orders, revenue, revenuePerVisitor, averageOrderValue, profit and profitPerVisitor. Each other view returns its own set, shown in the example and in the OpenAPI document.
Worth knowing
Segments are not filters. This splits one result set four ways; to narrow the experiment itself, use filters.
Small segments move a lot. Check
visitorsbefore reading anything into a segment's rates.Unnamed segments are left out, so the segments will not always add up to the experiment's totals.
Last updated