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()
      Search query.

    • setCount

      public TopSearchWithAnalytics setCount(Integer count)

    • getCount

      @Nonnull public Integer getCount()
      Number of searches.

    • setClickThroughRate

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

    • setAverageClickPosition

      public TopSearchWithAnalytics setAverageClickPosition(Double averageClickPosition)

    • getAverageClickPosition

      @Nullable public Double getAverageClickPosition()
      Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. minimum: 1

    • setClickPositions

      public TopSearchWithAnalytics setClickPositions(List<ClickPosition> clickPositions)

    • addClickPositions

      public TopSearchWithAnalytics addClickPositions(ClickPosition clickPositionsItem)

    • getClickPositions

      @Nonnull public List<ClickPosition> getClickPositions()
      List of positions in the search results and clicks associated with this search.

    • setConversionRate

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

    • setTrackedSearchCount

      public TopSearchWithAnalytics setTrackedSearchCount(Integer trackedSearchCount)

    • getTrackedSearchCount

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

    • setClickCount

      public TopSearchWithAnalytics setClickCount(Integer clickCount)

    • getClickCount

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

    • setConversionCount

      public TopSearchWithAnalytics setConversionCount(Integer conversionCount)

    • getConversionCount

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

    • setNbHits

      public TopSearchWithAnalytics setNbHits(Integer nbHits)

    • getNbHits

      @Nonnull public Integer getNbHits()
      Number of results (hits).

    • 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