feat(specs): revenue and filterEffects typing updates (#2105)

Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

Author: cdhawke

specs/abtesting/common/parameters.yml

@@ -48,3 +48,75 @@ trafficPercentage:
   type: integer
   description: A/B test traffic percentage.
   example: 60
+
+currencies:
+  type: object
+  description: A/B test currencies.
+  example:
+    USD:
+      currency: USD
+      revenue: 120.0
+      mean: 53.7
+      standardDeviation: 12.3
+    EUR:
+      currency: EUR
+      revenue: 100.0
+      mean: 43.7
+      standardDeviation: 10.3
+  additionalProperties:
+    type: object
+    properties:
+      currency:
+        type: string
+        description: Currency code.
+        example: 'USD'
+      revenue:
+        type: number
+        format: double
+        description: Revenue for this currency.
+        example: 120.0
+      mean:
+        type: number
+        format: double
+        description: Mean for this currency.
+        example: 53.7
+      standardDeviation:
+        type: number
+        format: double
+        description: Standard deviation for this currency.
+        example: 12.3
+    
+filterEffects:
+  type: object
+  description: A/B test filter effects resulting from configuration settings.
+  properties:
+    outliers:
+      type: object
+      description: Outliers removed from the A/B test as a result of configuration settings.
+      example:
+        usersCount: 1
+        trackedSearchesCount: 237
+      properties:
+        usersCount:
+          type: integer
+          description: Number of users removed from the A/B test.
+          example: 1
+        trackedSearchesCount:
+          type: integer
+          description: Number of tracked searches removed from the A/B test.
+          example: 237
+    emptySearch:
+      type: object
+      description: Empty searches removed from the A/B test as a result of configuration settings.
+      example:
+        usersCount: 1
+        trackedSearchesCount: 237
+      properties:
+        usersCount:
+          type: integer
+          description: Number of users removed from the A/B test.
+          example: 1
+        trackedSearchesCount:
+          type: integer
+          description: Number of tracked searches removed from the A/B test.
+          example: 237

specs/abtesting/common/schemas/ABTest.yml

@@ -21,11 +21,35 @@ ABTest:
       format: double
       description: >
         [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_.
-      $ref: '../parameters.yml#/endAt'
+      example: 1
+    addToCartSignificance:
+      type: number
+      format: double
+      description: >
+        [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_.
+      example: 1
+    purchaseSignificance:
+      type: number
+      format: double
+      description: >
+        [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_.
+      example: 1
+    revenueSignificance:
+      type: object
+      additionalProperties:
+        type: number
+        format: double
+      description: >
+        [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_.
+      example:
+        USD: 1
+        EUR: 0.87
     updatedAt:
       $ref: '../parameters.yml#/updatedAt'
     createdAt:
       $ref: '../parameters.yml#/createdAt'
+    endAt:
+      $ref: '../parameters.yml#/endAt'
     name:
       $ref: '../parameters.yml#/name'
     status:
@@ -42,5 +66,8 @@ ABTest:
     - updatedAt
     - conversionSignificance
     - clickSignificance
+    - purchaseSignificance
+    - addToCartSignificance
+    - revenueSignificance
     - abTestID
     - variants

specs/abtesting/common/schemas/Variant.yml

@@ -8,6 +8,15 @@ variant:
   type: object
   additionalProperties: false
   properties:
+    addToCartCount:
+      type: integer
+      description: Number of add-to-cart events for this variant.
+      example: 0
+    addToCartRate:
+      type: number
+      format: double
+      description: Variant's [add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate).
+      example: 0.0
     averageClickPosition:
       type: integer
       description: Variant's [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
@@ -30,22 +39,27 @@ variant:
       format: double
       description: Variant's [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
       example: 0.14546725846658964
+    currencies:
+      $ref: '../parameters.yml#/currencies'
     description:
       $ref: '../parameters.yml#/description'
+    filterEffects:
+      $ref: '../parameters.yml#/filterEffects'
     index:
       $ref: '../parameters.yml#/index'
     noResultCount:
       type: integer
       description: Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
       example: 0
-    outlierTrackedSearchesCount:
+    purchaseCount:
       type: integer
-      description: Number of tracked searches attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
-      example: 0
-    outlierUsersCount:
-      type: integer
-      description: Number of users attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test.
+      description: Number of purchase events for this variant.
       example: 0
+    purchaseRate:
+      type: number
+      format: double
+      description: Variant's [purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate).
+      example: 0.0
     searchCount:
       type: integer
       description: Number of searches carried out during the A/B test.
@@ -71,5 +85,8 @@ variant:
     - clickThroughRate
     - clickCount
     - averageClickPosition
-    - outlierUsersCount
-    - outlierTrackedSearchesCount
+    - currencies
+    - addToCartRate
+    - addToCartCount
+    - purchaseRate
+    - purchaseCount