Package com.algolia.model.abtesting

Class Variant

java.lang.Object
com.algolia.model.abtesting.Variant
public class Variant extends Object
Variant

  • Constructor Details

    • Variant

      public Variant()

  • Method Details

    • setAddToCartCount

      public Variant setAddToCartCount(Integer addToCartCount)

    • getAddToCartCount

      @Nonnull public Integer getAddToCartCount()
      Number of add-to-cart events for this variant.

    • setAddToCartRate

      public Variant setAddToCartRate(Double addToCartRate)

    • getAddToCartRate

      @Nullable public Double getAddToCartRate()
      [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.

    • setAverageClickPosition

      public Variant setAverageClickPosition(Integer averageClickPosition)

    • getAverageClickPosition

      @Nullable public Integer getAverageClickPosition()
      [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.

    • setClickCount

      public Variant setClickCount(Integer clickCount)

    • getClickCount

      @Nonnull public Integer getClickCount()
      Number of click events for this variant.

    • setClickThroughRate

      public Variant setClickThroughRate(Double clickThroughRate)

    • getClickThroughRate

      @Nullable public Double getClickThroughRate()
      [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.

    • setConversionCount

      public Variant setConversionCount(Integer conversionCount)

    • getConversionCount

      @Nonnull public Integer getConversionCount()
      Number of click events for this variant.

    • setConversionRate

      public Variant setConversionRate(Double conversionRate)

    • getConversionRate

      @Nullable public Double getConversionRate()
      [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.

    • setCurrencies

      public Variant setCurrencies(Map<String,Currency> currencies)

    • putCurrencies

      public Variant putCurrencies(String key, Currency currenciesItem)

    • getCurrencies

      @Nullable public Map<String,Currency> getCurrencies()
      A/B test currencies.

    • setDescription

      public Variant setDescription(String description)

    • getDescription

      @Nullable public String getDescription()
      Description for this variant.

    • setEstimatedSampleSize

      public Variant setEstimatedSampleSize(Integer estimatedSampleSize)

    • getEstimatedSampleSize

      @Nullable public Integer getEstimatedSampleSize()
      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.

    • setFilterEffects

      public Variant setFilterEffects(FilterEffects filterEffects)

    • getFilterEffects

      @Nullable public FilterEffects getFilterEffects()
      Get filterEffects

    • setIndex

      public Variant setIndex(String index)

    • getIndex

      @Nonnull public String getIndex()
      Index name of the A/B test variant (case-sensitive).

    • setNoResultCount

      public Variant setNoResultCount(Integer noResultCount)

    • getNoResultCount

      @Nullable public Integer getNoResultCount()
      Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.

    • setPurchaseCount

      public Variant setPurchaseCount(Integer purchaseCount)

    • getPurchaseCount

      @Nonnull public Integer getPurchaseCount()
      Number of purchase events for this variant.

    • setPurchaseRate

      public Variant setPurchaseRate(Double purchaseRate)

    • getPurchaseRate

      @Nullable public Double getPurchaseRate()
      [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.

    • setSearchCount

      public Variant setSearchCount(Integer searchCount)

    • getSearchCount

      @Nullable public Integer getSearchCount()
      Number of searches for this variant.

    • setTrackedSearchCount

      public Variant setTrackedSearchCount(Integer trackedSearchCount)

    • getTrackedSearchCount

      @Nullable public Integer getTrackedSearchCount()
      Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.

    • setTrafficPercentage

      public Variant setTrafficPercentage(Integer trafficPercentage)

    • getTrafficPercentage

      @Nonnull public Integer getTrafficPercentage()
      Percentage of search requests each variant receives. minimum: 0 maximum: 100

    • setUserCount

      public Variant setUserCount(Integer userCount)

    • getUserCount

      @Nullable public Integer getUserCount()
      Number of users that made searches to this variant.

    • setTrackedUserCount

      public Variant setTrackedUserCount(Integer trackedUserCount)

    • getTrackedUserCount

      @Nullable public Integer getTrackedUserCount()
      Number of users that made tracked searches to this variant.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object