You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: No A/B tests are configured for this application.
8
9
9
10
ABTest:
10
11
type: object
@@ -13,45 +14,62 @@ ABTest:
13
14
abTestID:
14
15
$ref: '../parameters.yml#/abTestID'
15
16
clickSignificance:
17
+
description: |
18
+
A/B test significance calculated from click events.
19
+
20
+
Values of 0.95 or higher can be considered significant,
21
+
that is, the difference between A and B variants is _not_ due to random variations.
22
+
Lower values have a.
16
23
oneOf:
17
24
- type: number
18
25
format: double
19
-
description: >
20
-
[A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on click data. A value of 0.95 or over is considered to be _significant_.
21
26
example: 1
22
27
- type: 'null'
23
28
conversionSignificance:
29
+
description: |
30
+
A/B test significance calculated from conversion events.
31
+
32
+
Values of 0.95 or higher can be considered significant,
33
+
that is, the difference between A and B variants is _not_ due to random variations.
24
34
oneOf:
25
35
- type: number
26
36
format: double
27
-
description: >
28
-
[A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on conversion. A value of 0.95 or over is considered to be _significant_.
29
37
example: 1
30
38
- type: 'null'
31
39
addToCartSignificance:
40
+
description: |
41
+
A/B test significance calculated from add-to-cart events.
42
+
43
+
Values of 0.95 or higher can be considered significant,
44
+
that is, the difference between A and B variants is _not_ due to random variations.
32
45
oneOf:
33
46
- type: number
34
47
format: double
35
-
description: >
36
-
[A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on add-to-cart data. A value of 0.95 or over is considered to be _significant_.
37
48
example: 1
38
49
- type: 'null'
39
50
purchaseSignificance:
51
+
description: |
52
+
A/B test significance calculated from purchase events.
53
+
54
+
Values of 0.95 or higher can be considered significant,
55
+
that is, the difference between A and B variants is _not_ due to random variations.
40
56
oneOf:
41
57
- type: number
42
58
format: double
43
-
description: >
44
-
[A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on purchase data. A value of 0.95 or over is considered to be _significant_.
45
59
example: 1
46
60
- type: 'null'
47
61
revenueSignificance:
62
+
description: |
63
+
A/B test significance calculated from revenue data.
64
+
65
+
Values of 0.95 or higher can be considered significant,
66
+
that is, the difference between A and B variants is _not_ due to random variations.
48
67
oneOf:
49
68
- type: object
50
69
additionalProperties:
51
70
type: number
52
71
format: double
53
-
description: >
54
-
[A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on revenue data. A value of 0.95 or over is considered to be _significant_.
72
+
x-additionalPropertiesName: currency code
55
73
example:
56
74
USD: 1
57
75
EUR: 0.87
@@ -65,11 +83,11 @@ ABTest:
65
83
name:
66
84
$ref: '../parameters.yml#/name'
67
85
status:
68
-
type: string
69
-
description: A/B test status.
70
-
example: 'running'
86
+
$ref: '#/Status'
71
87
variants:
72
88
$ref: 'Variant.yml#/variants'
89
+
configuration:
90
+
$ref: '#/ABTestConfiguration'
73
91
required:
74
92
- status
75
93
- name
@@ -83,3 +101,74 @@ ABTest:
83
101
- revenueSignificance
84
102
- abTestID
85
103
- variants
104
+
105
+
Status:
106
+
type: string
107
+
description: |
108
+
A/B test status.
109
+
110
+
- `active`. The A/B test is live and search traffic is split between the two variants.
111
+
- `stopped`. You stopped the A/B test. The A/B test data is still available for analysis.
112
+
- `expired`. The A/B test was automatically stopped after reaching its end date.
113
+
- `failed`. Creating the A/B test failed.
114
+
example: active
115
+
enum:
116
+
- active
117
+
- stopped
118
+
- expired
119
+
- failed
120
+
121
+
ABTestConfiguration:
122
+
title: configuration
123
+
type: object
124
+
description: A/B test configuration.
125
+
properties:
126
+
outliers:
127
+
$ref: '#/Outliers'
128
+
emptySearch:
129
+
$ref: '#/EmptySearch'
130
+
minimumDetectableEffect:
131
+
$ref: '#/MinimumDetectableEffect'
132
+
required:
133
+
- outliers
134
+
135
+
Outliers:
136
+
type: object
137
+
description: Configuration for handling outliers.
138
+
properties:
139
+
exclude:
140
+
type: boolean
141
+
description: Whether to exclude outliers when calculating A/B test results.
142
+
default: true
143
+
144
+
EmptySearch:
145
+
type: object
146
+
description: Configuration for handling empty searches.
147
+
properties:
148
+
exclude:
149
+
type: boolean
150
+
description: Whether to exclude empty searches when calculating A/B test results.
151
+
152
+
MinimumDetectableEffect:
153
+
type: object
154
+
description: Configuration for the smallest difference between test variants you want to detect.
155
+
properties:
156
+
size:
157
+
type: number
158
+
format: double
159
+
minimum: 0
160
+
maximum: 1
161
+
description: |
162
+
Smallest difference in an observable metric between variants.
163
+
For example, to detect a 10% difference between variants, set this value to 0.1.
164
+
effect:
165
+
$ref: '#/Effect'
166
+
167
+
Effect:
168
+
type: string
169
+
description: Metric for which you want to detect the smallest relative difference.
Copy file name to clipboardExpand all lines: specs/abtesting/common/schemas/AddABTestsVariant.yml
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -24,8 +24,10 @@ abTestsVariant:
24
24
25
25
customSearchParams:
26
26
type: object
27
-
description: Applies search parameters from [a restricted set of options](https://www.algolia.com/doc/api-reference/api-methods/add-ab-test/#method-param-customsearchparameters). Only use this parameter if the two variants use the same index.
[Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.
48
56
example: 0.14546725846658964
49
57
- type: 'null'
50
58
currencies:
@@ -53,7 +61,10 @@ variant:
53
61
$ref: '../parameters.yml#/description'
54
62
estimatedSampleSize:
55
63
type: integer
56
-
description: The estimated number of searches that will need to be run to achieve the desired confidence level and statistical power. A `minimumDetectableEffect` must be set in the `configuration` object for this to be used.
64
+
description: |
65
+
Estimated number of searches required to achieve the desired statistical significance.
66
+
67
+
The A/B test configuration must include a `mininmumDetectableEffect` setting for this number to be included in the response.
57
68
example: 0
58
69
filterEffects:
59
70
$ref: '../parameters.yml#/filterEffects'
@@ -62,7 +73,7 @@ variant:
62
73
noResultCount:
63
74
oneOf:
64
75
- type: integer
65
-
description: Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
76
+
description: Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.
0 commit comments