<back to all web services

GetABTest

The following routes are available for this service:
GET/RestApi/ab-testing/{id}
GetABTest Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidNo
ABTestViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TitleformstringNo
DescriptionformstringNo
StartDateformDateTime?No
StopDateformDateTime?No
PageformGuidNo
SiteIdformGuidNo
CultureformstringNo
VariationsformIEnumerable<VariationViewModel>No
GoalsformIEnumerable<GoalViewModel>No
ReportUrlformstringNo
LastModifiedformDateTimeNo
StatusformABTestStatusNo
OwnerformstringNo
WinnerVariationIdformGuid?No
SelectedVariationIdformGuid?No
PageNodeErrorMessageformstringNo
WarningMessageformstringNo
ApiKeyformstringNo
UserSegmentIdformGuid?No
VariationViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
NameformstringNo
DistributionformintNo
IsOriginalformboolNo
OrdinalformintNo
PageDataIdformGuid?No
IsWinnerformboolNo
GoalViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
GoalTypeformGoalTypeNo
GoalNameResourceKeyformstringNo
PredicateOperatorformstringNo
ObjectIdformstringNo
ObjectNameformstringNo
ObjectCultureformstringNo
IsPrimaryformboolNo
OrdinalformintNo
GoalType Enum:
NextPageView
FormSubmission
DecConversion
ABTestStatus Enum:
NotStarted
Scheduled
Active
Stopped
Ended

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /RestApi/ab-testing/{id} HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Title: String,
	Description: String,
	StartDate: 0001-01-01,
	StopDate: 0001-01-01,
	Culture: String,
	ReportUrl: String,
	LastModified: 0001-01-01,
	Status: NotStarted,
	Owner: String,
	WinnerVariationId: 00000000-0000-0000-0000-000000000000,
	SelectedVariationId: 00000000-0000-0000-0000-000000000000,
	PageNodeErrorMessage: String,
	WarningMessage: String,
	ApiKey: String,
	UserSegmentId: 00000000-0000-0000-0000-000000000000
}