algoliasearch.abtesting.Variant.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-scala_3 Show documentation
Scala client for Algolia Search API
There is a newer version: 2.9.2
Show newest version
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
  * experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
  * \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
  * servers, based on your geographical location) Use the URL that matches your [analytics
  * region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
  * Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
  * plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
  * `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
  * permissions to make the request. The required access control list (ACL) to make a request is listed in each
  * endpoint's reference. You can find your application ID and API key in the [Algolia
  * dashboard](https://dashboard.algolia.com/account). ## Rate limits You can make up to **100 requests per minute per
  * app** to the A/B testing API. The response includes headers with information about the limits. ## Parameters Query
  * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
  * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
  * A/B testing API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order
  * of attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
  * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
  * Version The current version of the A/B Testing API is version 2, as indicated by the `/2/` in each endpoint's URL.
  *
  * The version of the OpenAPI document: 2.0.0
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech Do not edit the class manually.
  */
package algoliasearch.abtesting

/** Variant
  *
  * @param addToCartCount
  *   Number of add-to-cart events for this variant.
  * @param addToCartRate
  *   [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for
  *   this variant.
  * @param averageClickPosition
  *   [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for
  *   this variant.
  * @param clickCount
  *   Number of click events for this variant.
  * @param clickThroughRate
  *   [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for
  *   this variant.
  * @param conversionCount
  *   Number of click events for this variant.
  * @param conversionRate
  *   [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this
  *   variant.
  * @param currencies
  *   A/B test currencies.
  * @param description
  *   Description for this variant.
  * @param estimatedSampleSize
  *   Estimated number of searches required to achieve the desired statistical significance. The A/B test configuration
  *   must include a `mininmumDetectableEffect` setting for this number to be included in the response.
  * @param index
  *   Index name of the A/B test variant (case-sensitive).
  * @param noResultCount
  *   Number of [searches without
  *   results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this
  *   variant.
  * @param purchaseCount
  *   Number of purchase events for this variant.
  * @param purchaseRate
  *   [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this
  *   variant.
  * @param searchCount
  *   Number of searches for this variant.
  * @param trackedSearchCount
  *   Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param trafficPercentage
  *   Percentage of search requests each variant receives.
  * @param userCount
  *   Number of users that made searches to this variant.
  * @param trackedUserCount
  *   Number of users that made tracked searches to this variant.
  */
case class Variant(
    addToCartCount: Int,
    addToCartRate: Option[Double] = scala.None,
    averageClickPosition: Option[Int] = scala.None,
    clickCount: Int,
    clickThroughRate: Option[Double] = scala.None,
    conversionCount: Int,
    conversionRate: Option[Double] = scala.None,
    currencies: Option[Map[String, Currency]] = scala.None,
    description: String,
    estimatedSampleSize: Option[Int] = scala.None,
    filterEffects: Option[FilterEffects] = scala.None,
    index: String,
    noResultCount: Option[Int] = scala.None,
    purchaseCount: Int,
    purchaseRate: Option[Double] = scala.None,
    searchCount: Option[Int] = scala.None,
    trackedSearchCount: Option[Int] = scala.None,
    trafficPercentage: Int,
    userCount: Option[Int] = scala.None,
    trackedUserCount: Option[Int] = scala.None
)