Package com.algolia.model.analytics

Class TopSearchWithRevenueAnalytics

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

  • Constructor Details

    • TopSearchWithRevenueAnalytics

      public TopSearchWithRevenueAnalytics()

  • Method Details

    • setSearch

      public TopSearchWithRevenueAnalytics setSearch(String search)

    • getSearch

      @Nonnull public String getSearch()
      Search query.

    • setCount

      public TopSearchWithRevenueAnalytics setCount(Integer count)

    • getCount

      @Nonnull public Integer getCount()
      Number of searches.

    • setClickThroughRate

      public TopSearchWithRevenueAnalytics 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 TopSearchWithRevenueAnalytics 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 TopSearchWithRevenueAnalytics setClickPositions(List<ClickPositionsInner> clickPositions)

    • addClickPositions

      public TopSearchWithRevenueAnalytics addClickPositions(ClickPositionsInner clickPositionsItem)

    • getClickPositions

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

    • setConversionRate

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

    • getClickCount

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

    • setConversionCount

      public TopSearchWithRevenueAnalytics setConversionCount(Integer conversionCount)

    • getConversionCount

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

    • setNbHits

      public TopSearchWithRevenueAnalytics setNbHits(Integer nbHits)

    • getNbHits

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

    • setCurrencies

      public TopSearchWithRevenueAnalytics setCurrencies(Map<String,CurrenciesValue> currencies)

    • putCurrencies

      public TopSearchWithRevenueAnalytics putCurrencies(String key, CurrenciesValue currenciesItem)

    • getCurrencies

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

    • setAddToCartRate

      public TopSearchWithRevenueAnalytics 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 TopSearchWithRevenueAnalytics setAddToCartCount(Integer addToCartCount)

    • getAddToCartCount

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

    • setPurchaseRate

      public TopSearchWithRevenueAnalytics 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 TopSearchWithRevenueAnalytics setPurchaseCount(Integer purchaseCount)

    • getPurchaseCount

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

    • 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