Package com.algolia.model.analytics

Class GetClickThroughRateResponse

java.lang.Object

com.algolia.model.analytics.GetClickThroughRateResponse

public class GetClickThroughRateResponse
extends Object

GetClickThroughRateResponse

Constructor Summary

Constructors

Constructor	Description
GetClickThroughRateResponse()

Method Summary

Modifier and Type	Method	Description
GetClickThroughRateResponse	addDates(ClickThroughRateEvent datesItem)
boolean	equals(Object o)
Integer	getClickCount()	Number of click events.
List<ClickThroughRateEvent>	getDates()	Click-through rate events.
Double	getRate()	[Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
Integer	getTrackedSearchCount()	Number of tracked searches.
int	hashCode()
GetClickThroughRateResponse	setClickCount(Integer clickCount)
GetClickThroughRateResponse	setDates(List<ClickThroughRateEvent> dates)
GetClickThroughRateResponse	setRate(Double rate)
GetClickThroughRateResponse	setTrackedSearchCount(Integer trackedSearchCount)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GetClickThroughRateResponse

public GetClickThroughRateResponse()

Method Details

setRate

public GetClickThroughRateResponse setRate(Double rate)

getRate

@Nonnull
public Double getRate()

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

Returns:

rate

setClickCount

public GetClickThroughRateResponse setClickCount(Integer clickCount)

getClickCount

@Nonnull
public Integer getClickCount()

Number of click events.

Returns:

clickCount

setTrackedSearchCount

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

setDates

public GetClickThroughRateResponse setDates(List<ClickThroughRateEvent> dates)

addDates

public GetClickThroughRateResponse addDates(ClickThroughRateEvent datesItem)

getDates

@Nonnull
public List<ClickThroughRateEvent> getDates()

Click-through rate events.

Returns:

dates

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