Connect REST API Developer Guide
jNewer Version Available
Personalization Experiment Creation
Create a personalization experiment.
- Resource
-
1personalization/abn-experiments/?action=${action} - Available version
- 65.0
- HTTP method
- POST
- Request body
- Personalization Experiment Input
- Request parameters
-
Parameter Name Type Description Required or Optional action Personalization Experiment Action Enum Starts, stops, or archives the experiment. Optional - Response body
- Personalization Experiment
Example
Request:
1{
2 "chanceToWinThreshold": 95,
3 "cohorts": [
4 {
5 "allocationWeight": 5000,
6 "attributeValues": [
7 {
8 "attributeName": "Attr1",
9 "value": "1"
10 }
11 ],
12 "isControl": true,
13 "isFallThrough": false,
14 "label": "Cohort 1 (Control)",
15 "name": "cohort_1"
16 },
17 {
18 "allocationWeight": 5000,
19 "attributeValues": [
20 {
21 "attributeName": "Attr1",
22 "value": "2"
23 }
24 ],
25 "isControl": false,
26 "isFallThrough": false,
27 "label": "Cohort 2",
28 "name": "cohort_2"
29 }
30 ],
31 "dataSpaceName": "default",
32 "description": null,
33 "label": "testExp50",
34 "maximumDurationInMinutes": 129600,
35 "minimumDurationInMinutes": 20160,
36 "minimumRequiredParticipants": 1000,
37 "name": "testExp50",
38 "parameters": [
39 {
40 "engagementSignalName": "Flow_Email_Click_3",
41 "parameterName": "DeviceModel",
42 "values": ["iPhone 16", "iPad Air", "iPad Mini"]
43 },
44 {
45 "engagementSignalName": "Flow_Email_Click_3",
46 "parameterName": "EmailsInFlowExp",
47 "values": ["testEmail1", "testEmail1"]
48 },
49 {
50 "engagementSignalName": "A_New_Flow_Email_Click_New",
51 "parameterName": "EmailsInFlowExp2",
52 "values": ["testEmail3", "testEmail3"]
53 },
54 {
55 "engagementSignalName": "Flow_Email_Click_3",
56 "parameterName": "OS",
57 "values": ["iOS 26", "iOS 18"]
58 }
59 ],
60 "primaryMetric": {
61 "higherIsBetter": true,
62 "metricName": "TwoCompound",
63 "metricType": "EngagementSignalCompound"
64 },
65 "profileDataGraphName": "RTDG",
66 "scheduleFrequencyInMinutes": 1440,
67 "schemaName": "AResponseTemplate",
68 "secondaryMetrics": [
69 {
70 "engagementSignalName": "Flow_Email_Click_3",
71 "higherIsBetter": true,
72 "metricName": "Count Indv_Flow_Email_Click_3",
73 "metricType": "EngagementSignal"
74 }
75 ],
76 "source": "FlowBuilder",
77 "sourceRecordId": null,
78 "winnerSelectionMode": "Manual"
79}Response:
1{
2 "chanceToWinThreshold": 95,
3 "cohorts": [
4 {
5 "allocationWeight": 5000,
6 "attributeValues": [
7 {
8 "attributeName": "Attr1",
9 "value": "1"
10 }
11 ],
12 "isControl": true,
13 "isFallThrough": false,
14 "label": "Cohort 1 (Control)",
15 "name": "cohort_1"
16 },
17 {
18 "allocationWeight": 5000,
19 "attributeValues": [
20 {
21 "attributeName": "Attr1",
22 "value": "2"
23 }
24 ],
25 "isControl": false,
26 "isFallThrough": false,
27 "label": "Cohort 2",
28 "name": "cohort_2"
29 }
30 ],
31 "dataSpaceName": "default",
32 "description": null,
33 "label": "testExp50",
34 "maximumDurationInMinutes": 129600,
35 "minimumDurationInMinutes": 20160,
36 "minimumRequiredParticipants": 1000,
37 "name": "testExp50",
38 "parameters": [
39 {
40 "engagementSignalName": "Flow_Email_Click_3",
41 "parameterName": "DeviceModel",
42 "values": ["iPhone 16", "iPad Air", "iPad Mini"]
43 },
44 {
45 "engagementSignalName": "Flow_Email_Click_3",
46 "parameterName": "EmailsInFlowExp",
47 "values": ["testEmail1", "testEmail1"]
48 },
49 {
50 "engagementSignalName": "A_New_Flow_Email_Click_New",
51 "parameterName": "EmailsInFlowExp2",
52 "values": ["testEmail3", "testEmail3"]
53 },
54 {
55 "engagementSignalName": "Flow_Email_Click_3",
56 "parameterName": "OS",
57 "values": ["iOS 26", "iOS 18"]
58 }
59 ],
60 "primaryMetric": {
61 "higherIsBetter": true,
62 "metricName": "TwoCompound",
63 "metricType": "EngagementSignalCompound"
64 },
65 "profileDataGraphName": "RTDG",
66 "scheduleFrequencyInMinutes": 1440,
67 "schemaName": "AResponseTemplate",
68 "secondaryMetrics": [
69 {
70 "engagementSignalName": "Flow_Email_Click_3",
71 "higherIsBetter": true,
72 "metricName": "Count Indv_Flow_Email_Click_3",
73 "metricType": "EngagementSignal"
74 }
75 ],
76 "source": "FlowBuilder",
77 "sourceRecordId": null,
78 "winnerSelectionMode": "Manual",
79state: "Created",
80startedDate: null,
81stoppedDate: null,
82status: "Processing"
83}