Package com.algolia.model.analytics

Class TopHitWithAnalytics

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

  • Constructor Details

    • TopHitWithAnalytics

      public TopHitWithAnalytics()

  • Method Details

    • setHit

      public TopHitWithAnalytics setHit(String hit)

    • getHit

      @Nonnull public String getHit()
      Hit.
      Returns:
      hit

    • setCount

      public TopHitWithAnalytics setCount(Integer count)

    • getCount

      @Nonnull public Integer getCount()
      Number of occurrences.
      Returns:
      count

    • setClickThroughRate

      public TopHitWithAnalytics setClickThroughRate(Double clickThroughRate)

    • getClickThroughRate

      @Nonnull public Double getClickThroughRate()
      [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate). minimum: 0 maximum: 1
      Returns:
      clickThroughRate

    • setConversionRate

      public TopHitWithAnalytics setConversionRate(Double conversionRate)

    • getConversionRate

      @Nonnull public Double getConversionRate()
      [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Returns:
      conversionRate

    • setTrackedSearchCount

      public TopHitWithAnalytics setTrackedSearchCount(Integer trackedSearchCount)

    • getTrackedSearchCount

      @Nonnull public Integer getTrackedSearchCount()
      Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      Returns:
      trackedSearchCount

    • setClickCount

      public TopHitWithAnalytics setClickCount(Integer clickCount)

    • getClickCount

      @Nonnull public Integer getClickCount()
      Number of click events.
      Returns:
      clickCount

    • setConversionCount

      public TopHitWithAnalytics setConversionCount(Integer conversionCount)

    • getConversionCount

      @Nonnull public Integer getConversionCount()
      Number of converted clicks.
      Returns:
      conversionCount

    • 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