AbTest document (Data API 17.8)

Document representing an A/B Test

Property Type Constraints Description
customer_groups [String] maxItems=50, nullable=false The list of customer group ids assigned to the A/B Test. Defaults to 'Everyone' if not specified on create
description String maxLength=4000 The optional description of the A/B Test
email_addresses [String] maxItems=50 The optional list of email addresses to send A/B Test results
enabled Boolean nullable=false The flag representing the enabled state of the A/B Test. Defaults to false if not specified on create
end_date DateTime nullable=false The date that the A/B Test ends. Defaults to two weeks from creation date if both start and end dates are not specified on create
expiration_type ABTestExpiration nullable=false The participant expiration type of the A/B Test. Defaults to 'never' if not specified on create
id String maxLength=40, minLength=1, nullable=false The id of the A/B Test
key_metric_id String maxLength=256, nullable=false The key metric that is most important to the A/B Test, among the metrics collected. Defaults to 'Revenue' if not specified from test participant activity
link String   The URL to get the A/B test. This is a computed attribute and cannot be modified
paused Boolean   The flag representing the paused state of the A/B Test. Defaults to false if not specified on create
start_date DateTime nullable=false The date that the A/B Test begins. Defaults to a week from creation date if both start and end dates are not specified on create
tags [String] maxItems=50 The optional list of tags to group similar A/B Tests so that they can be searched easily.
test_groups [AbTestGroup]   Test Groups created for an A/B Test. This is a read only attribute for now.
test_segments [AbTestSegment]   Test Segments created for an A/B Test. This is a read only attribute for now
trigger AbTestTrigger nullable=false The trigger that allows the test participant to be considered for an A/B Test
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.