Package com.algolia.model.analytics

Class TopHitWithRevenueAnalytics

java.lang.Object
com.algolia.model.analytics.TopHitWithRevenueAnalytics
public class TopHitWithRevenueAnalytics extends Object
TopHitWithRevenueAnalytics

  • Constructor Details

    • TopHitWithRevenueAnalytics

      public TopHitWithRevenueAnalytics()

  • Method Details

    • setHit

      public TopHitWithRevenueAnalytics setHit(String hit)

    • getHit

      @Nonnull public String getHit()
      Object ID of a record that's returned as a search result.

    • setCount

      public TopHitWithRevenueAnalytics setCount(Integer count)

    • getCount

      @Nonnull public Integer getCount()
      Number of occurrences.

    • setClickThroughRate

      public TopHitWithRevenueAnalytics setClickThroughRate(Double clickThroughRate)

    • getClickThroughRate

      @Nullable public Double getClickThroughRate()
      Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. minimum: 0 maximum: 1

    • setConversionRate

      public TopHitWithRevenueAnalytics setConversionRate(Double conversionRate)

    • getConversionRate

      @Nullable public Double getConversionRate()
      Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. minimum: 0 maximum: 1

    • setTrackedHitCount

      public TopHitWithRevenueAnalytics setTrackedHitCount(Integer trackedHitCount)

    • getTrackedHitCount

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

    • setClickCount

      public TopHitWithRevenueAnalytics setClickCount(Integer clickCount)

    • getClickCount

      @Nonnull public Integer getClickCount()
      Number of clicks associated with this search. minimum: 0

    • setConversionCount

      public TopHitWithRevenueAnalytics setConversionCount(Integer conversionCount)

    • getConversionCount

      @Nonnull public Integer getConversionCount()
      Number of conversions from this search. minimum: 0

    • setAddToCartRate

      public TopHitWithRevenueAnalytics setAddToCartRate(Double addToCartRate)

    • getAddToCartRate

      @Nullable public Double getAddToCartRate()
      Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. minimum: 0 maximum: 1

    • setAddToCartCount

      public TopHitWithRevenueAnalytics setAddToCartCount(Integer addToCartCount)

    • getAddToCartCount

      @Nonnull public Integer getAddToCartCount()
      Number of add-to-cart events from this search. minimum: 0

    • setPurchaseRate

      public TopHitWithRevenueAnalytics setPurchaseRate(Double purchaseRate)

    • getPurchaseRate

      @Nullable public Double getPurchaseRate()
      Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. minimum: 0 maximum: 1

    • setPurchaseCount

      public TopHitWithRevenueAnalytics setPurchaseCount(Integer purchaseCount)

    • getPurchaseCount

      @Nonnull public Integer getPurchaseCount()
      Number of purchase events from this search.

    • setCurrencies

      public TopHitWithRevenueAnalytics setCurrencies(Map<String,CurrencyCode> currencies)

    • putCurrencies

      public TopHitWithRevenueAnalytics putCurrencies(String key, CurrencyCode currenciesItem)

    • getCurrencies

      @Nonnull public Map<String,CurrencyCode> getCurrencies()
      Revenue associated with this search, broken-down by currencies.

    • 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