Package com.algolia.model.analytics

Class TopSearchWithAnalytics

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

  • Constructor Details

    • TopSearchWithAnalytics

      public TopSearchWithAnalytics()

  • Method Details

    • setSearch

      public TopSearchWithAnalytics setSearch(String search)

    • getSearch

      @Nonnull public String getSearch()
      User query.
      Returns:
      search

    • setCount

      public TopSearchWithAnalytics setCount(Integer count)

    • getCount

      @Nonnull public Integer getCount()
      Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn't `true`).
      Returns:
      count

    • setClickThroughRate

      public TopSearchWithAnalytics 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

    • setAverageClickPosition

      public TopSearchWithAnalytics setAverageClickPosition(Integer averageClickPosition)

    • getAverageClickPosition

      @Nonnull public Integer getAverageClickPosition()
      Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result.
      Returns:
      averageClickPosition

    • setConversionRate

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

    • getClickCount

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

    • setConversionCount

      public TopSearchWithAnalytics setConversionCount(Integer conversionCount)

    • getConversionCount

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

    • setNbHits

      public TopSearchWithAnalytics setNbHits(Integer nbHits)

    • getNbHits

      @Nonnull public Integer getNbHits()
      Number of hits the search query matched.
      Returns:
      nbHits

    • 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