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()
      Object ID of a record that's returned as a search result.

    • setCount

      public TopHitWithAnalytics setCount(Integer count)

    • getCount

      @Nonnull public Integer getCount()
      Number of occurrences.

    • setClickThroughRate

      public TopHitWithAnalytics 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 TopHitWithAnalytics 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 TopHitWithAnalytics 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 TopHitWithAnalytics setClickCount(Integer clickCount)

    • getClickCount

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

    • setConversionCount

      public TopHitWithAnalytics setConversionCount(Integer conversionCount)

    • getConversionCount

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

    • 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