@algolia/n8n-nodes-algolia 0.5.2 → 0.7.0

package/dist/nodes/Algolia/specs/abtesting.json

@@ -0,0 +1,1493 @@
+{
+  "openapi": "3.0.2",
+  "info": {
+    "title": "A/B Testing API",
+    "description": "The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience.\n\n## Base URLs\n\nThe base URLs for requests to the A/B testing API are:\n\n- `https://analytics.us.algolia.com`\n- `https://analytics.de.algolia.com`\n- `https://analytics.algolia.com` (alias of `analytics.us.algolia.com`)\n\nUse the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).\n\n**All requests must use HTTPS.**\n\n## Availability and authentication\n\nAccess to the A/B testing API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\n\nTo authenticate your API requests, add these headers:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. An API key with the necessary permissions to make the request.\n  The required access control list (ACL) to make a request is listed in each endpoint's reference.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).\n\n## Rate limits\n\nYou can make up to **100 requests per minute per app** to the A/B testing API.\nThe response includes headers with information about the limits.\n\n## Parameters\n\nQuery parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding).\nNon-ASCII characters must be UTF-8 encoded.\nPlus characters (`+`) are interpreted as spaces.\n\n## Response status and errors\n\nThe A/B testing API returns JSON responses.\nSince JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.\n\nSuccessful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.\nError responses have a `message` property with more information.\n\n## Version\n\nThe current version of the A/B Testing API is version 2, as indicated by the `/2/` in each endpoint's URL.\n",
+    "version": "2.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://analytics.{region}.algolia.com",
+      "variables": {
+        "region": {
+          "description": "The region where your Algolia application is hosted.",
+          "enum": ["us", "de"],
+          "default": "us"
+        }
+      }
+    },
+    {
+      "url": "https://analytics.algolia.com"
+    }
+  ],
+  "security": [
+    {
+      "applicationId": [],
+      "apiKey": []
+    }
+  ],
+  "tags": [
+    {
+      "name": "abtest",
+      "x-displayName": "A/B testing",
+      "description": "Manage A/B tests.\n\nA/B tests are configurations one or more indices, usually your production index and an index with different settings that you want to test.\n"
+    }
+  ],
+  "externalDocs": {
+    "url": "https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing",
+    "description": "A/B testing."
+  },
+  "paths": {
+    "/{path}": {
+      "get": {
+        "operationId": "customGet",
+        "summary": "Send requests to the Algolia REST API",
+        "description": "This method lets you send requests to the Algolia REST API.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/PathInPath"
+          },
+          {
+            "$ref": "#/components/parameters/Parameters"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      },
+      "post": {
+        "operationId": "customPost",
+        "requestBody": {
+          "description": "Parameters to send with the custom request.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        },
+        "summary": "Send requests to the Algolia REST API",
+        "description": "This method lets you send requests to the Algolia REST API.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/PathInPath"
+          },
+          {
+            "$ref": "#/components/parameters/Parameters"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      },
+      "put": {
+        "operationId": "customPut",
+        "requestBody": {
+          "description": "Parameters to send with the custom request.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        },
+        "summary": "Send requests to the Algolia REST API",
+        "description": "This method lets you send requests to the Algolia REST API.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/PathInPath"
+          },
+          {
+            "$ref": "#/components/parameters/Parameters"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "customDelete",
+        "summary": "Send requests to the Algolia REST API",
+        "description": "This method lets you send requests to the Algolia REST API.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/PathInPath"
+          },
+          {
+            "$ref": "#/components/parameters/Parameters"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      }
+    },
+    "/2/abtests": {
+      "post": {
+        "tags": ["abtest"],
+        "operationId": "addABTests",
+        "x-acl": ["editSettings"],
+        "summary": "Create an A/B test",
+        "description": "Creates a new A/B test.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "title": "addABTestsRequest",
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "name": {
+                    "$ref": "#/components/schemas/name"
+                  },
+                  "variants": {
+                    "type": "array",
+                    "description": "A/B test variants.",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {
+                      "$ref": "#/components/schemas/AddABTestsVariant"
+                    }
+                  },
+                  "endAt": {
+                    "$ref": "#/components/schemas/endAt"
+                  }
+                },
+                "required": ["name", "variants", "endAt"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "x-ratelimit-limit": {
+                "$ref": "#/components/headers/x-ratelimit-limit"
+              },
+              "x-ratelimit-remaining": {
+                "$ref": "#/components/headers/x-ratelimit-remaining"
+              },
+              "x-ratelimit-reset": {
+                "$ref": "#/components/headers/x-ratelimit-reset"
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ABTestResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      },
+      "get": {
+        "tags": ["abtest"],
+        "operationId": "listABTests",
+        "x-mcp-tool": true,
+        "x-acl": ["analytics"],
+        "summary": "List all A/B tests",
+        "description": "Lists all A/B tests you configured for this application.",
+        "parameters": [
+          {
+            "name": "offset",
+            "in": "query",
+            "description": "Position of the first item to return.",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 0,
+              "minimum": 0
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Number of items to return.",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 10
+            }
+          },
+          {
+            "name": "indexPrefix",
+            "in": "query",
+            "description": "Index name prefix. Only A/B tests for indices starting with this string are included in the response.",
+            "example": "dev_",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "indexSuffix",
+            "in": "query",
+            "description": "Index name suffix. Only A/B tests for indices ending with this string are included in the response.",
+            "example": "_development",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "x-ratelimit-limit": {
+                "$ref": "#/components/headers/x-ratelimit-limit"
+              },
+              "x-ratelimit-remaining": {
+                "$ref": "#/components/headers/x-ratelimit-remaining"
+              },
+              "x-ratelimit-reset": {
+                "$ref": "#/components/headers/x-ratelimit-reset"
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "listABTestsResponse",
+                  "type": "object",
+                  "additionalProperties": false,
+                  "properties": {
+                    "abtests": {
+                      "$ref": "#/components/schemas/ABTests"
+                    },
+                    "count": {
+                      "type": "integer",
+                      "description": "Number of A/B tests.",
+                      "example": 10
+                    },
+                    "total": {
+                      "type": "integer",
+                      "description": "Number of retrievable A/B tests.",
+                      "example": 12
+                    }
+                  },
+                  "required": ["abtests", "count", "total"]
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      }
+    },
+    "/2/abtests/{id}": {
+      "get": {
+        "tags": ["abtest"],
+        "operationId": "getABTest",
+        "x-acl": ["analytics"],
+        "summary": "Retrieve A/B test details",
+        "description": "Retrieves the details for an A/B test by its ID.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ID"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "x-ratelimit-limit": {
+                "$ref": "#/components/headers/x-ratelimit-limit"
+              },
+              "x-ratelimit-remaining": {
+                "$ref": "#/components/headers/x-ratelimit-remaining"
+              },
+              "x-ratelimit-reset": {
+                "$ref": "#/components/headers/x-ratelimit-reset"
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ABTest"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      },
+      "delete": {
+        "tags": ["abtest"],
+        "operationId": "deleteABTest",
+        "x-acl": ["editSettings"],
+        "summary": "Delete an A/B test",
+        "description": "Deletes an A/B test by its ID.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ID"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "x-ratelimit-limit": {
+                "$ref": "#/components/headers/x-ratelimit-limit"
+              },
+              "x-ratelimit-remaining": {
+                "$ref": "#/components/headers/x-ratelimit-remaining"
+              },
+              "x-ratelimit-reset": {
+                "$ref": "#/components/headers/x-ratelimit-reset"
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ABTestResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      }
+    },
+    "/2/abtests/{id}/stop": {
+      "post": {
+        "tags": ["abtest"],
+        "operationId": "stopABTest",
+        "x-acl": ["editSettings"],
+        "summary": "Stop an A/B test",
+        "description": "Stops an A/B test by its ID.\n\nYou can't restart stopped A/B tests.\n",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ID"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "x-ratelimit-limit": {
+                "$ref": "#/components/headers/x-ratelimit-limit"
+              },
+              "x-ratelimit-remaining": {
+                "$ref": "#/components/headers/x-ratelimit-remaining"
+              },
+              "x-ratelimit-reset": {
+                "$ref": "#/components/headers/x-ratelimit-reset"
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ABTestResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      }
+    },
+    "/2/abtests/schedule": {
+      "post": {
+        "tags": ["abtest"],
+        "operationId": "scheduleABTest",
+        "x-acl": ["editSettings"],
+        "summary": "Schedule an A/B test",
+        "description": "Schedule an A/B test to be started at a later time.\n",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "title": "scheduleABTestsRequest",
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "name": {
+                    "$ref": "#/components/schemas/name"
+                  },
+                  "variants": {
+                    "type": "array",
+                    "description": "A/B test variants.",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {
+                      "$ref": "#/components/schemas/AddABTestsVariant"
+                    }
+                  },
+                  "scheduledAt": {
+                    "$ref": "#/components/schemas/scheduledAt"
+                  },
+                  "endAt": {
+                    "$ref": "#/components/schemas/endAt"
+                  }
+                },
+                "required": ["name", "variants", "scheduledAt", "endAt"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "x-ratelimit-limit": {
+                "$ref": "#/components/headers/x-ratelimit-limit"
+              },
+              "x-ratelimit-remaining": {
+                "$ref": "#/components/headers/x-ratelimit-remaining"
+              },
+              "x-ratelimit-reset": {
+                "$ref": "#/components/headers/x-ratelimit-reset"
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ScheduleABTestResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      }
+    },
+    "/2/abtests/estimate": {
+      "post": {
+        "tags": ["abtest"],
+        "operationId": "estimateABTest",
+        "x-acl": ["analytics"],
+        "summary": "Estimate the sample size and duration of an A/B test",
+        "description": "Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "title": "estimateABTestRequest",
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "configuration": {
+                    "title": "estimateConfiguration",
+                    "type": "object",
+                    "description": "A/B test configuration for estimating the sample size and duration using minimum detectable effect.",
+                    "properties": {
+                      "outliers": {
+                        "$ref": "#/components/schemas/Outliers"
+                      },
+                      "emptySearch": {
+                        "$ref": "#/components/schemas/EmptySearch"
+                      },
+                      "minimumDetectableEffect": {
+                        "$ref": "#/components/schemas/MinimumDetectableEffect"
+                      }
+                    },
+                    "required": ["minimumDetectableEffect"]
+                  },
+                  "variants": {
+                    "type": "array",
+                    "description": "A/B test variants.",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {
+                      "$ref": "#/components/schemas/AddABTestsVariant"
+                    }
+                  }
+                },
+                "required": ["configuration", "variants"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "x-ratelimit-limit": {
+                "$ref": "#/components/headers/x-ratelimit-limit"
+              },
+              "x-ratelimit-remaining": {
+                "$ref": "#/components/headers/x-ratelimit-remaining"
+              },
+              "x-ratelimit-reset": {
+                "$ref": "#/components/headers/x-ratelimit-reset"
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EstimateABTestResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "402": {
+            "$ref": "#/components/responses/FeatureNotEnabled"
+          },
+          "403": {
+            "$ref": "#/components/responses/MethodNotAllowed"
+          },
+          "404": {
+            "$ref": "#/components/responses/IndexNotFound"
+          }
+        }
+      }
+    },
+    "/setClientApiKey": {
+      "get": {
+        "x-helper": true,
+        "x-asynchronous-helper": false,
+        "tags": ["Api Key"],
+        "operationId": "setClientApiKey",
+        "summary": "Switch the API key used to authenticate requests",
+        "description": "Switch the API key used to authenticate requests.\n",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "apiKey",
+            "description": "API key to be used from now on.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No content."
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "applicationId": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "x-algolia-application-id",
+        "description": "Your Algolia application ID."
+      },
+      "apiKey": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "x-algolia-api-key",
+        "description": "Your Algolia API key with the necessary permissions to make the request.\nPermissions are controlled through access control lists (ACL) and access restrictions.\nThe required ACL to make a request is listed in each endpoint's reference.\n"
+      }
+    },
+    "parameters": {
+      "PathInPath": {
+        "name": "path",
+        "in": "path",
+        "description": "Path of the endpoint, for example `1/newFeature`.",
+        "required": true,
+        "schema": {
+          "type": "string",
+          "example": "/keys"
+        }
+      },
+      "Parameters": {
+        "name": "parameters",
+        "in": "query",
+        "description": "Query parameters to apply to the current query.",
+        "schema": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      },
+      "ID": {
+        "in": "path",
+        "name": "id",
+        "description": "Unique A/B test identifier.",
+        "required": true,
+        "schema": {
+          "$ref": "#/components/schemas/abTestID"
+        }
+      }
+    },
+    "schemas": {
+      "ErrorBase": {
+        "description": "Error.",
+        "type": "object",
+        "x-keep-model": true,
+        "additionalProperties": true,
+        "properties": {
+          "message": {
+            "type": "string",
+            "example": "Invalid Application-Id or API-Key"
+          }
+        }
+      },
+      "abTestID": {
+        "type": "integer",
+        "description": "Unique A/B test identifier.",
+        "example": 224
+      },
+      "updatedAt": {
+        "type": "string",
+        "description": "Date and time when the A/B test was last updated, in RFC 3339 format.",
+        "example": "2023-06-15T15:06:44.400601Z"
+      },
+      "createdAt": {
+        "type": "string",
+        "description": "Date and time when the A/B test was created, in RFC 3339 format.",
+        "example": "2023-06-15T15:06:04.249906Z"
+      },
+      "endAt": {
+        "type": "string",
+        "description": "End date and time of the A/B test, in RFC 3339 format.",
+        "example": "2023-06-17T00:00:00Z"
+      },
+      "stoppedAt": {
+        "type": "string",
+        "description": "Date and time when the A/B test was stopped, in RFC 3339 format.",
+        "example": "2023-06-15T15:06:44.400601Z",
+        "nullable": true
+      },
+      "name": {
+        "type": "string",
+        "description": "A/B test name.",
+        "example": "Custom ranking sales rank test"
+      },
+      "Status": {
+        "type": "string",
+        "description": "A/B test status.\n\n- `active`. The A/B test is live and search traffic is split between the two variants.\n- `stopped`. You stopped the A/B test. The A/B test data is still available for analysis.\n- `expired`. The A/B test was automatically stopped after reaching its end date.\n- `failed`. Creating the A/B test failed.\n",
+        "example": "active",
+        "enum": ["active", "stopped", "expired", "failed"]
+      },
+      "currency": {
+        "type": "object",
+        "properties": {
+          "currency": {
+            "type": "string",
+            "description": "Currency code.",
+            "example": "USD"
+          },
+          "revenue": {
+            "type": "number",
+            "format": "double",
+            "description": "Revenue for this currency.",
+            "example": 120
+          },
+          "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
+          },
+          "winsorizedAmount": {
+            "type": "number",
+            "format": "double",
+            "description": "The amount of revenue for this currency that was removed after capping purchase amounts to the 95th percentile.",
+            "example": 23
+          }
+        }
+      },
+      "currencies": {
+        "type": "object",
+        "description": "A/B test currencies.",
+        "example": {
+          "USD": {
+            "currency": "USD",
+            "revenue": 120,
+            "mean": 53.7,
+            "standardDeviation": 12.3,
+            "winsorizedAmount": 23
+          },
+          "EUR": {
+            "currency": "EUR",
+            "revenue": 100,
+            "mean": 43.7,
+            "standardDeviation": 10.3,
+            "winsorizedAmount": 10
+          }
+        },
+        "additionalProperties": {
+          "$ref": "#/components/schemas/currency",
+          "x-additionalPropertiesName": "currency code"
+        }
+      },
+      "description": {
+        "type": "string",
+        "description": "Description for this variant.",
+        "example": "Current production index"
+      },
+      "filterEffects": {
+        "type": "object",
+        "description": "A/B test filter effects resulting from configuration settings.",
+        "properties": {
+          "outliers": {
+            "title": "outliersFilter",
+            "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": {
+            "title": "emptySearchFilter",
+            "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
+              }
+            }
+          }
+        }
+      },
+      "index": {
+        "type": "string",
+        "description": "Index name of the A/B test variant (case-sensitive).",
+        "example": "delcourt_production"
+      },
+      "trackedSearchCount": {
+        "type": "integer",
+        "example": 2,
+        "default": 0,
+        "description": "Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true."
+      },
+      "trafficPercentage": {
+        "type": "integer",
+        "description": "Percentage of search requests each variant receives.",
+        "minimum": 0,
+        "maximum": 100,
+        "example": 60
+      },
+      "variant": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "addToCartCount": {
+            "type": "integer",
+            "description": "Number of add-to-cart events for this variant.",
+            "example": 0
+          },
+          "addToCartRate": {
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "description": "[Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.\n",
+                "example": 0
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "averageClickPosition": {
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "description": "[Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.\n",
+                "example": 29.12342
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "clickCount": {
+            "type": "integer",
+            "description": "Number of click events for this variant.",
+            "example": 65131
+          },
+          "clickThroughRate": {
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "description": "[Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.\n",
+                "example": 0.22219857724813036
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "conversionCount": {
+            "type": "integer",
+            "description": "Number of click events for this variant.",
+            "example": 4785
+          },
+          "conversionRate": {
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "description": "[Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.\n",
+                "example": 0.14546725846658964
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "currencies": {
+            "$ref": "#/components/schemas/currencies"
+          },
+          "description": {
+            "$ref": "#/components/schemas/description"
+          },
+          "estimatedSampleSize": {
+            "type": "integer",
+            "description": "Estimated number of searches required to achieve the desired statistical significance.\n\nThe A/B test configuration must include a `mininmumDetectableEffect` setting for this number to be included in the response.\n",
+            "example": 0
+          },
+          "filterEffects": {
+            "$ref": "#/components/schemas/filterEffects"
+          },
+          "index": {
+            "$ref": "#/components/schemas/index"
+          },
+          "noResultCount": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "description": "Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.",
+                "example": 0
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "purchaseCount": {
+            "type": "integer",
+            "description": "Number of purchase events for this variant.",
+            "example": 0
+          },
+          "purchaseRate": {
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "description": "[Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.\n",
+                "example": 0
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "searchCount": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "description": "Number of searches for this variant.",
+                "example": 86269
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "trackedSearchCount": {
+            "$ref": "#/components/schemas/trackedSearchCount"
+          },
+          "trafficPercentage": {
+            "$ref": "#/components/schemas/trafficPercentage"
+          },
+          "userCount": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "description": "Number of users that made searches to this variant.",
+                "example": 55501
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "trackedUserCount": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "description": "Number of users that made tracked searches to this variant.",
+                "example": 55501
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "userCount",
+          "trackedUserCount",
+          "trafficPercentage",
+          "searchCount",
+          "noResultCount",
+          "index",
+          "conversionCount",
+          "clickCount",
+          "addToCartCount",
+          "purchaseCount"
+        ]
+      },
+      "variants": {
+        "type": "array",
+        "description": "A/B test variants.\n\nThe first variant is your _control_ index, typically your production index.\nThe second variant is an index with changed settings that you want to test against the control.\n",
+        "items": {
+          "$ref": "#/components/schemas/variant"
+        }
+      },
+      "Outliers": {
+        "type": "object",
+        "description": "Configuration for handling outliers.",
+        "properties": {
+          "exclude": {
+            "type": "boolean",
+            "description": "Whether to exclude outliers when calculating A/B test results.",
+            "default": true
+          }
+        }
+      },
+      "EmptySearch": {
+        "type": "object",
+        "description": "Configuration for handling empty searches.",
+        "properties": {
+          "exclude": {
+            "type": "boolean",
+            "description": "Whether to exclude empty searches when calculating A/B test results."
+          }
+        }
+      },
+      "EffectMetric": {
+        "type": "string",
+        "description": "Metric for which you want to detect the smallest relative difference.",
+        "enum": ["addToCartRate", "clickThroughRate", "conversionRate", "purchaseRate"]
+      },
+      "MinimumDetectableEffect": {
+        "type": "object",
+        "description": "Configuration for the smallest difference between test variants you want to detect.",
+        "properties": {
+          "size": {
+            "type": "number",
+            "format": "double",
+            "minimum": 0,
+            "maximum": 1,
+            "description": "Smallest difference in an observable metric between variants.\nFor example, to detect a 10% difference between variants, set this value to 0.1.\n"
+          },
+          "metric": {
+            "$ref": "#/components/schemas/EffectMetric"
+          }
+        },
+        "required": ["size", "metric"]
+      },
+      "ABTestConfiguration": {
+        "title": "configuration",
+        "type": "object",
+        "description": "A/B test configuration.",
+        "properties": {
+          "outliers": {
+            "$ref": "#/components/schemas/Outliers"
+          },
+          "emptySearch": {
+            "$ref": "#/components/schemas/EmptySearch"
+          },
+          "minimumDetectableEffect": {
+            "$ref": "#/components/schemas/MinimumDetectableEffect"
+          }
+        }
+      },
+      "ABTest": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "abTestID": {
+            "$ref": "#/components/schemas/abTestID"
+          },
+          "clickSignificance": {
+            "description": "A/B test significance calculated from click events.\n\nValues of 0.95 or higher can be considered significant,\nthat is, the difference between A and B variants is _not_ due to random variations.\nLower values have a.\n",
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "example": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "conversionSignificance": {
+            "description": "A/B test significance calculated from conversion events.\n\nValues of 0.95 or higher can be considered significant,\nthat is, the difference between A and B variants is _not_ due to random variations.\n",
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "example": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "addToCartSignificance": {
+            "description": "A/B test significance calculated from add-to-cart events.\n\nValues of 0.95 or higher can be considered significant,\nthat is, the difference between A and B variants is _not_ due to random variations.\n",
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "example": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "purchaseSignificance": {
+            "description": "A/B test significance calculated from purchase events.\n\nValues of 0.95 or higher can be considered significant,\nthat is, the difference between A and B variants is _not_ due to random variations.\n",
+            "oneOf": [
+              {
+                "type": "number",
+                "format": "double",
+                "example": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "revenueSignificance": {
+            "description": "A/B test significance calculated from revenue data.\n\nValues of 0.95 or higher can be considered significant,\nthat is, the difference between A and B variants is _not_ due to random variations.\n",
+            "oneOf": [
+              {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "number",
+                  "format": "double",
+                  "x-additionalPropertiesName": "currency code"
+                },
+                "example": {
+                  "USD": 1,
+                  "EUR": 0.87
+                }
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "updatedAt": {
+            "$ref": "#/components/schemas/updatedAt"
+          },
+          "createdAt": {
+            "$ref": "#/components/schemas/createdAt"
+          },
+          "endAt": {
+            "$ref": "#/components/schemas/endAt"
+          },
+          "stoppedAt": {
+            "$ref": "#/components/schemas/stoppedAt"
+          },
+          "name": {
+            "$ref": "#/components/schemas/name"
+          },
+          "status": {
+            "$ref": "#/components/schemas/Status"
+          },
+          "variants": {
+            "$ref": "#/components/schemas/variants"
+          },
+          "configuration": {
+            "$ref": "#/components/schemas/ABTestConfiguration"
+          }
+        },
+        "required": ["status", "name", "createdAt", "endAt", "updatedAt", "abTestID", "variants"]
+      },
+      "ABTests": {
+        "oneOf": [
+          {
+            "type": "array",
+            "description": "The list of A/B tests, null if no A/B tests are configured for this application.",
+            "items": {
+              "$ref": "#/components/schemas/ABTest"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "abTestsVariant": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "index": {
+            "$ref": "#/components/schemas/index"
+          },
+          "trafficPercentage": {
+            "$ref": "#/components/schemas/trafficPercentage"
+          },
+          "description": {
+            "$ref": "#/components/schemas/description"
+          }
+        },
+        "required": ["index", "trafficPercentage"]
+      },
+      "customSearchParams": {
+        "type": "object",
+        "description": "Search parameters to add to the test variant.\nOnly use this parameter if the two variants use the same index.\n",
+        "example": {
+          "typoTolerance": false,
+          "synonyms": false
+        },
+        "additionalProperties": false,
+        "properties": {
+          "customSearchParameters": {
+            "type": "object"
+          }
+        },
+        "required": ["customSearchParameters"],
+        "x-discriminator-fields": ["customSearchParameters"]
+      },
+      "abTestsVariantSearchParams": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/abTestsVariant"
+          },
+          {
+            "$ref": "#/components/schemas/customSearchParams"
+          }
+        ]
+      },
+      "AddABTestsVariant": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/abTestsVariant"
+          },
+          {
+            "$ref": "#/components/schemas/abTestsVariantSearchParams"
+          }
+        ]
+      },
+      "taskID": {
+        "type": "integer",
+        "format": "int64",
+        "example": 1514562690001,
+        "description": "Unique identifier of a task.\n\nA successful API response means that a task was added to a queue.\nIt might not run immediately.\nYou can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.\n"
+      },
+      "ABTestResponse": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "index": {
+            "$ref": "#/components/schemas/index"
+          },
+          "abTestID": {
+            "$ref": "#/components/schemas/abTestID"
+          },
+          "taskID": {
+            "$ref": "#/components/schemas/taskID"
+          }
+        },
+        "required": ["abTestID", "index", "taskID"]
+      },
+      "scheduledAt": {
+        "type": "string",
+        "description": "Date and time when the A/B test is scheduled to start, in RFC 3339 format.",
+        "example": "2023-06-15T15:06:44.400601Z"
+      },
+      "abTestScheduleID": {
+        "type": "integer",
+        "description": "Unique scheduled A/B test identifier.",
+        "example": 224
+      },
+      "ScheduleABTestResponse": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "abTestScheduleID": {
+            "$ref": "#/components/schemas/abTestScheduleID"
+          }
+        },
+        "required": ["abTestScheduleID"]
+      },
+      "EstimateABTestResponse": {
+        "type": "object",
+        "properties": {
+          "durationDays": {
+            "type": "integer",
+            "format": "int64",
+            "description": "Estimated number of days needed to reach the sample sizes required for detecting the configured effect. This value is based on historical traffic.",
+            "example": 21
+          },
+          "sampleSizes": {
+            "type": "array",
+            "description": "Sample size estimates for each variant. The first element is the control variant.\nEach element is the estimated number of searches required to achieve the desired statistical significance.\n",
+            "items": {
+              "type": "integer",
+              "format": "int64",
+              "description": "Number of tracked searches needed to be able to detect the configured effect for the control variant.",
+              "example": 23415
+            }
+          }
+        }
+      }
+    },
+    "responses": {
+      "BadRequest": {
+        "description": "Bad request or request arguments.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ErrorBase"
+            }
+          }
+        }
+      },
+      "FeatureNotEnabled": {
+        "description": "This feature is not enabled on your Algolia account.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ErrorBase"
+            }
+          }
+        }
+      },
+      "MethodNotAllowed": {
+        "description": "Method not allowed with this API key.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ErrorBase"
+            }
+          }
+        }
+      },
+      "IndexNotFound": {
+        "description": "Index not found.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ErrorBase"
+            }
+          }
+        }
+      }
+    },
+    "headers": {
+      "x-ratelimit-limit": {
+        "description": "Number of allowed requests per one minute.",
+        "example": 100,
+        "schema": {
+          "type": "integer"
+        }
+      },
+      "x-ratelimit-remaining": {
+        "description": "Number of remaining requests in the current period.",
+        "example": 99,
+        "schema": {
+          "type": "integer"
+        }
+      },
+      "x-ratelimit-reset": {
+        "description": "Timstamp when the rate limit will reset, measured in seconds since the Unix epoch.",
+        "example": 1710682486,
+        "schema": {
+          "type": "integer"
+        }
+      }
+    }
+  },
+  "x-tagGroups": [
+    {
+      "name": "General",
+      "tags": ["abtest"]
+    }
+  ]
+}