algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.analytics

algoliasearch.analytics

package algoliasearch.analytics

Members list

Type members

Classlikes

case class ClickPositionsInner(position: Option[Seq[Int]], clickCount: Option[Int])

Click position.

Click position.

Value parameters

clickCount

Number of times this search has been clicked at that position.

position

Range of positions in the search results, using the pattern [start,end]. For positions 11 and up, click events are summed over the specified range. -1 indicates the end of the list of search results.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class CurrenciesValue(currency: Option[String], revenue: Option[Float])

Currency code.

Currency code.

Value parameters

currency

Currency code.

revenue

Revenue associated with this search in this currency.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyAddToCartRates(rate: Option[Double], trackedSearchCount: Int, addToCartCount: Int, date: String)

DailyAddToCartRates

DailyAddToCartRates

Value parameters

addToCartCount

Number of add-to-cart events from this search.

date

Date in the format YYYY-MM-DD.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyAverageClicks(average: Option[Double], clickCount: Int, date: String)

DailyAverageClicks

DailyAverageClicks

Value parameters

average

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.

clickCount

Number of clicks associated with this search.

date

Date in the format YYYY-MM-DD.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyClickThroughRates(rate: Option[Double], clickCount: Int, trackedSearchCount: Int, date: String)

DailyClickThroughRates

DailyClickThroughRates

Value parameters

clickCount

Number of clicks associated with this search.

date

Date in the format YYYY-MM-DD.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyConversionRates(rate: Option[Double], trackedSearchCount: Int, conversionCount: Int, date: String)

DailyConversionRates

DailyConversionRates

Value parameters

conversionCount

Number of conversions from this search.

date

Date in the format YYYY-MM-DD.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyNoClickRates(rate: Double, count: Int, noClickCount: Int, date: String)

DailyNoClickRates

DailyNoClickRates

Value parameters

count

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

date

Date in the format YYYY-MM-DD.

noClickCount

Number of times this search was returned as a result without any click.

rate

No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyNoResultsRates(date: String, noResultCount: Int, count: Int, rate: Double)

DailyNoResultsRates

DailyNoResultsRates

Value parameters

count

Number of searches.

date

Date in the format YYYY-MM-DD.

noResultCount

Number of searches without any results.

rate

No results rate, calculated as number of searches with zero results divided by the total number of searches.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyPurchaseRates(rate: Option[Double], trackedSearchCount: Int, purchaseCount: Int, date: String)

DailyPurchaseRates

DailyPurchaseRates

Value parameters

date

Date in the format YYYY-MM-DD.

purchaseCount

Number of purchase events from this search.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyRevenue(currencies: Map[String, CurrenciesValue], date: String)

DailyRevenue

DailyRevenue

Value parameters

currencies

Revenue associated with this search, broken-down by currencies.

date

Date in the format YYYY-MM-DD.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailySearches(date: String, count: Int)

DailySearches

DailySearches

Value parameters

count

Number of occurrences.

date

Date in the format YYYY-MM-DD.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailySearchesNoClicks(search: String, count: Int, nbHits: Int)

DailySearchesNoClicks

DailySearchesNoClicks

Value parameters

count

Number of tracked searches.

nbHits

Number of results (hits).

search

Search query.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailySearchesNoResults(search: String, count: Int, withFilterCount: Int)

DailySearchesNoResults

DailySearchesNoResults

Value parameters

count

Number of occurrences.

search

Search query.

withFilterCount

Number of searches for this term with applied filters.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DailyUsers(date: String, count: Int)

DailyUsers

DailyUsers

Value parameters

count

Number of unique users.

date

Date in the format YYYY-MM-DD.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Direction

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Asc.type
object Desc.type
object Direction

Direction enumeration

Direction enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Direction.type
class DirectionSerializer extends CustomSerializer[Direction]

Attributes

Supertypes
class CustomSerializer[Direction]
trait Serializer[Direction]
class Object
trait Matchable
class Any
case class ErrorBase(message: Option[String], additionalProperties: Option[List[JField]])

Error.

Error.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class ErrorBaseSerializer extends Serializer[ErrorBase]

Attributes

Supertypes
trait Serializer[ErrorBase]
class Object
trait Matchable
class Any
case class GetAddToCartRateResponse(rate: Option[Double], trackedSearchCount: Int, addToCartCount: Int, dates: Seq[DailyAddToCartRates])

GetAddToCartRateResponse

GetAddToCartRateResponse

Value parameters

addToCartCount

Number of add-to-cart events from this search.

dates

Daily add-to-cart rates.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetAverageClickPositionResponse(average: Option[Double], clickCount: Int, dates: Seq[DailyAverageClicks])

GetAverageClickPositionResponse

GetAverageClickPositionResponse

Value parameters

average

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.

clickCount

Number of clicks associated with this search.

dates

Daily average click positions.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetClickPositionsResponse(positions: Seq[ClickPositionsInner])

GetClickPositionsResponse

GetClickPositionsResponse

Value parameters

positions

List of positions in the search results and clicks associated with this search.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetClickThroughRateResponse(rate: Option[Double], clickCount: Int, trackedSearchCount: Int, dates: Seq[DailyClickThroughRates])

GetClickThroughRateResponse

GetClickThroughRateResponse

Value parameters

clickCount

Number of clicks associated with this search.

dates

Daily click-through rates.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetConversionRateResponse(rate: Option[Double], trackedSearchCount: Int, conversionCount: Int, dates: Seq[DailyConversionRates])

GetConversionRateResponse

GetConversionRateResponse

Value parameters

conversionCount

Number of conversions from this search.

dates

Daily conversion rates.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetNoClickRateResponse(rate: Double, count: Int, noClickCount: Int, dates: Seq[DailyNoClickRates])

GetNoClickRateResponse

GetNoClickRateResponse

Value parameters

count

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

dates

Daily no click rates.

noClickCount

Number of times this search was returned as a result without any click.

rate

No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetNoResultsRateResponse(rate: Double, count: Int, noResultCount: Int, dates: Seq[DailyNoResultsRates])

GetNoResultsRateResponse

GetNoResultsRateResponse

Value parameters

count

Number of searches.

dates

Daily no results rates.

noResultCount

Number of searches without any results.

rate

No results rate, calculated as number of searches with zero results divided by the total number of searches.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetPurchaseRateResponse(rate: Option[Double], trackedSearchCount: Int, purchaseCount: Int, dates: Seq[DailyPurchaseRates])

GetPurchaseRateResponse

GetPurchaseRateResponse

Value parameters

dates

Daily purchase rates.

purchaseCount

Number of purchase events from this search.

rate

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.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetRevenue(currencies: Map[String, CurrenciesValue], dates: Seq[DailyRevenue])

GetRevenue

GetRevenue

Value parameters

currencies

Revenue associated with this search, broken-down by currencies.

dates

Daily revenue.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetSearchesCountResponse(count: Int, dates: Seq[DailySearches])

GetSearchesCountResponse

GetSearchesCountResponse

Value parameters

count

Number of occurrences.

dates

Daily number of searches.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetSearchesNoClicksResponse(searches: Seq[DailySearchesNoClicks])

GetSearchesNoClicksResponse

GetSearchesNoClicksResponse

Value parameters

searches

Searches without any clicks.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetSearchesNoResultsResponse(searches: Seq[DailySearchesNoResults])

GetSearchesNoResultsResponse

GetSearchesNoResultsResponse

Value parameters

searches

Searches without results.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetStatusResponse(updatedAt: Option[String])

GetStatusResponse

GetStatusResponse

Value parameters

updatedAt

Date and time when the object was updated, in RFC 3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopCountriesResponse(countries: Seq[TopCountry])

GetTopCountriesResponse

GetTopCountriesResponse

Value parameters

countries

Countries and number of searches.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopFilterAttribute(attribute: String, count: Int)

GetTopFilterAttribute

GetTopFilterAttribute

Value parameters

attribute

Attribute name.

count

Number of occurrences.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopFilterAttributesResponse(attributes: Seq[GetTopFilterAttribute])

GetTopFilterAttributesResponse

GetTopFilterAttributesResponse

Value parameters

attributes

Most frequent filters.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopFilterForAttribute(attribute: String, operator: Operator, value: String, count: Int)

GetTopFilterForAttribute

GetTopFilterForAttribute

Value parameters

attribute

Attribute name.

count

Number of occurrences.

value

Attribute value.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopFilterForAttributeResponse(values: Seq[GetTopFilterForAttribute])

GetTopFilterForAttributeResponse

GetTopFilterForAttributeResponse

Value parameters

values

Filter values for an attribute.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopFiltersNoResultsResponse(values: Option[Seq[GetTopFiltersNoResultsValues]])

GetTopFiltersNoResultsResponse

GetTopFiltersNoResultsResponse

Value parameters

values

Filters for searches without any results. If null, the search term specified with the search parameter is not a search without results, or the search parameter is absent from the request.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopFiltersNoResultsValue(attribute: String, operator: Operator, value: String)

GetTopFiltersNoResultsValue

GetTopFiltersNoResultsValue

Value parameters

attribute

Attribute name.

value

Attribute value.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetTopFiltersNoResultsValues(count: Int, values: Seq[GetTopFiltersNoResultsValue])

GetTopFiltersNoResultsValues

GetTopFiltersNoResultsValues

Value parameters

count

Number of occurrences.

values

Filters with no results.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait GetTopHitsResponse

GetTopHitsResponse

GetTopHitsResponse

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GetTopHitsResponse

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object GetTopHitsResponseSerializer extends Serializer[GetTopHitsResponse]

Attributes

Supertypes
trait Serializer[GetTopHitsResponse]
class Object
trait Matchable
class Any
Self type
trait GetTopHitsResponseTrait extends GetTopHitsResponse

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait GetTopSearchesResponse

GetTopSearchesResponse

GetTopSearchesResponse

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GetTopSearchesResponse

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object GetTopSearchesResponseSerializer extends Serializer[GetTopSearchesResponse]

Attributes

Supertypes
trait Serializer[GetTopSearchesResponse]
class Object
trait Matchable
class Any
Self type
trait GetTopSearchesResponseTrait extends GetTopSearchesResponse

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class GetUsersCountResponse(count: Int, dates: Seq[DailyUsers])

GetUsersCountResponse

GetUsersCountResponse

Value parameters

count

Number of unique users.

dates

Daily number of unique users.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object JsonSupport

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Operator

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Colon.type
object Equal.type
object GreaterThan.type
object GreaterThanOrEqualTo.type
object LessThan.type
object LessThanOrEqualTo.type
object NotEqual.type
Show all
object Operator

Character that characterizes how the filter is applied. For example, for a facet filter facet:value, : is the operator. For a numeric filter count>50, > is the operator.

Character that characterizes how the filter is applied. For example, for a facet filter facet:value, : is the operator. For a numeric filter count>50, > is the operator.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Operator.type
class OperatorSerializer extends CustomSerializer[Operator]

Attributes

Supertypes
class CustomSerializer[Operator]
trait Serializer[Operator]
class Object
trait Matchable
class Any
sealed trait OrderBy

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AverageClickPosition.type
object ClickThroughRate.type
object ConversionRate.type
object SearchCount.type
object OrderBy

Attribute by which to order the response items. If the clickAnalytics parameter is false, only searchCount is available.

Attribute by which to order the response items. If the clickAnalytics parameter is false, only searchCount is available.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
OrderBy.type
class OrderBySerializer extends CustomSerializer[OrderBy]

Attributes

Supertypes
class CustomSerializer[OrderBy]
trait Serializer[OrderBy]
class Object
trait Matchable
class Any
case class TopCountry(country: String, count: Int)

TopCountry

TopCountry

Value parameters

count

Number of occurrences.

country

Country code.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopHit(hit: String, count: Int)

TopHit

TopHit

Value parameters

count

Number of occurrences.

hit

Object ID of a record that's returned as a search result.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopHitWithAnalytics(hit: String, count: Int, clickThroughRate: Option[Double], conversionRate: Option[Double], trackedHitCount: Int, clickCount: Int, conversionCount: Int)

TopHitWithAnalytics

TopHitWithAnalytics

Value parameters

clickCount

Number of clicks associated with this search.

clickThroughRate

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.

conversionCount

Number of conversions from this search.

conversionRate

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.

count

Number of occurrences.

hit

Object ID of a record that's returned as a search result.

trackedHitCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopHitWithRevenueAnalytics(hit: String, count: Int, clickThroughRate: Option[Double], conversionRate: Option[Double], trackedHitCount: Int, clickCount: Int, conversionCount: Int, addToCartRate: Option[Double], addToCartCount: Int, purchaseRate: Option[Double], purchaseCount: Int, currencies: Map[String, CurrenciesValue])

TopHitWithRevenueAnalytics

TopHitWithRevenueAnalytics

Value parameters

addToCartCount

Number of add-to-cart events from this search.

addToCartRate

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.

clickCount

Number of clicks associated with this search.

clickThroughRate

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.

conversionCount

Number of conversions from this search.

conversionRate

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.

count

Number of occurrences.

currencies

Revenue associated with this search, broken-down by currencies.

hit

Object ID of a record that's returned as a search result.

purchaseCount

Number of purchase events from this search.

purchaseRate

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.

trackedHitCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopHitsResponse(hits: Seq[TopHit]) extends GetTopHitsResponseTrait

TopHitsResponse

TopHitsResponse

Value parameters

hits

Most frequent search results.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopHitsResponseWithAnalytics(hits: Seq[TopHitWithAnalytics]) extends GetTopHitsResponseTrait

TopHitsResponseWithAnalytics

TopHitsResponseWithAnalytics

Value parameters

hits

Most frequent search results with click and conversion metrics.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopHitsResponseWithRevenueAnalytics(hits: Seq[TopHitWithRevenueAnalytics]) extends GetTopHitsResponseTrait

TopHitsResponseWithRevenueAnalytics

TopHitsResponseWithRevenueAnalytics

Value parameters

hits

Most frequent search results with click, conversion, and revenue metrics.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopSearch(search: String, count: Int, nbHits: Int)

TopSearch

TopSearch

Value parameters

count

Number of searches.

nbHits

Number of results (hits).

search

Search query.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopSearchWithAnalytics(search: String, count: Int, clickThroughRate: Option[Double], averageClickPosition: Option[Double], clickPositions: Seq[ClickPositionsInner], conversionRate: Option[Double], trackedSearchCount: Int, clickCount: Int, conversionCount: Int, nbHits: Int)

TopSearchWithAnalytics

TopSearchWithAnalytics

Value parameters

averageClickPosition

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.

clickCount

Number of clicks associated with this search.

clickPositions

List of positions in the search results and clicks associated with this search.

clickThroughRate

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.

conversionCount

Number of conversions from this search.

conversionRate

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.

count

Number of searches.

nbHits

Number of results (hits).

search

Search query.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopSearchWithRevenueAnalytics(search: String, count: Int, clickThroughRate: Option[Double], averageClickPosition: Option[Double], clickPositions: Seq[ClickPositionsInner], conversionRate: Option[Double], trackedSearchCount: Int, clickCount: Int, conversionCount: Int, nbHits: Int, currencies: Map[String, CurrenciesValue], addToCartRate: Option[Double], addToCartCount: Int, purchaseRate: Option[Double], purchaseCount: Int)

TopSearchWithRevenueAnalytics

TopSearchWithRevenueAnalytics

Value parameters

addToCartCount

Number of add-to-cart events from this search.

addToCartRate

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.

averageClickPosition

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.

clickCount

Number of clicks associated with this search.

clickPositions

List of positions in the search results and clicks associated with this search.

clickThroughRate

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.

conversionCount

Number of conversions from this search.

conversionRate

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.

count

Number of searches.

currencies

Revenue associated with this search, broken-down by currencies.

nbHits

Number of results (hits).

purchaseCount

Number of purchase events from this search.

purchaseRate

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.

search

Search query.

trackedSearchCount

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopSearchesResponse(searches: Seq[TopSearch]) extends GetTopSearchesResponseTrait

TopSearchesResponse

TopSearchesResponse

Value parameters

searches

Most popular searches and their number of search results (hits).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopSearchesResponseWithAnalytics(searches: Seq[TopSearchWithAnalytics]) extends GetTopSearchesResponseTrait

TopSearchesResponseWithAnalytics

TopSearchesResponseWithAnalytics

Value parameters

searches

Most popular searches and their associated click and conversion metrics.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TopSearchesResponseWithRevenueAnalytics(searches: Seq[TopSearchWithRevenueAnalytics]) extends GetTopSearchesResponseTrait

TopSearchesResponseWithRevenueAnalytics

TopSearchesResponseWithRevenueAnalytics

Value parameters

searches

Most popular searches, including their click and revenue metrics.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with