analytics

package analytics

Ordering

Alphabetic

Visibility

Public
Protected

Type Members

case class ClickPosition(position: Option[Seq[Int]] = scala.None, clickCount: Option[Int] = scala.None) extends Product with Serializable
Click position.
Click 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.
clickCount
Number of times this search has been clicked at that position.
case class CurrenciesValue(currency: Option[String] = scala.None, revenue: Option[Float] = scala.None) extends Product with Serializable
Currency code.
Currency code.
currency
Currency code.
revenue
Revenue associated with this search in this currency.
case class DailyAddToCartRates(rate: Option[Double] = scala.None, trackedSearchCount: Int, addToCartCount: Int, date: String) extends Product with Serializable
DailyAddToCartRates
DailyAddToCartRates
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.
addToCartCount
Number of add-to-cart events from this search.
date
Date in the format YYYY-MM-DD.
case class DailyAverageClicks(average: Option[Double] = scala.None, clickCount: Int, date: String) extends Product with Serializable
DailyAverageClicks
DailyAverageClicks
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.
case class DailyClickThroughRates(rate: Option[Double] = scala.None, clickCount: Int, trackedSearchCount: Int, date: String) extends Product with Serializable
DailyClickThroughRates
DailyClickThroughRates
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.
clickCount
Number of clicks associated with this search.
trackedSearchCount
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
date
Date in the format YYYY-MM-DD.
case class DailyConversionRates(rate: Option[Double] = scala.None, trackedSearchCount: Int, conversionCount: Int, date: String) extends Product with Serializable
DailyConversionRates
DailyConversionRates
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.
conversionCount
Number of conversions from this search.
date
Date in the format YYYY-MM-DD.
case class DailyNoClickRates(rate: Double, count: Int, noClickCount: Int, date: String) extends Product with Serializable
DailyNoClickRates
DailyNoClickRates
rate
No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
count
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
noClickCount
Number of times this search was returned as a result without any click.
date
Date in the format YYYY-MM-DD.
case class DailyNoResultsRates(date: String, noResultCount: Int, count: Int, rate: Double) extends Product with Serializable
DailyNoResultsRates
DailyNoResultsRates
date
Date in the format YYYY-MM-DD.
noResultCount
Number of searches without any results.
count
Number of searches.
rate
No results rate, calculated as number of searches with zero results divided by the total number of searches.
case class DailyPurchaseRates(rate: Option[Double] = scala.None, trackedSearchCount: Int, purchaseCount: Int, date: String) extends Product with Serializable
DailyPurchaseRates
DailyPurchaseRates
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.
purchaseCount
Number of purchase events from this search.
date
Date in the format YYYY-MM-DD.
case class DailyRevenue(currencies: Map[String, CurrenciesValue], date: String) extends Product with Serializable
DailyRevenue
DailyRevenue
currencies
Revenue associated with this search, broken-down by currencies.
date
Date in the format YYYY-MM-DD.
case class DailySearches(date: String, count: Int) extends Product with Serializable
DailySearches
DailySearches
date
Date in the format YYYY-MM-DD.
count
Number of occurrences.
case class DailySearchesNoClicks(search: String, count: Int, nbHits: Int) extends Product with Serializable
DailySearchesNoClicks
DailySearchesNoClicks
search
Search query.
count
Number of tracked searches.
nbHits
Number of results (hits).
case class DailySearchesNoResults(search: String, count: Int, withFilterCount: Int) extends Product with Serializable
DailySearchesNoResults
DailySearchesNoResults
search
Search query.
count
Number of occurrences.
withFilterCount
Number of searches for this term with applied filters.
case class DailyUsers(date: String, count: Int) extends Product with Serializable
DailyUsers
DailyUsers
date
Date in the format YYYY-MM-DD.
count
Number of unique users.
sealed trait Direction extends AnyRef
class DirectionSerializer extends CustomSerializer[Direction]
case class ErrorBase(message: Option[String] = scala.None, additionalProperties: Option[List[JField]] = None) extends Product with Serializable
Error.
class ErrorBaseSerializer extends Serializer[ErrorBase]
case class GetAddToCartRateResponse(rate: Option[Double] = scala.None, trackedSearchCount: Int, addToCartCount: Int, dates: Seq[DailyAddToCartRates]) extends Product with Serializable
GetAddToCartRateResponse
GetAddToCartRateResponse
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.
addToCartCount
Number of add-to-cart events from this search.
dates
Daily add-to-cart rates.
case class GetAverageClickPositionResponse(average: Option[Double] = scala.None, clickCount: Int, dates: Seq[DailyAverageClicks]) extends Product with Serializable
GetAverageClickPositionResponse
GetAverageClickPositionResponse
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.
case class GetClickPositionsResponse(positions: Seq[ClickPosition]) extends Product with Serializable
GetClickPositionsResponse
GetClickPositionsResponse
positions
List of positions in the search results and clicks associated with this search.
case class GetClickThroughRateResponse(rate: Option[Double] = scala.None, clickCount: Int, trackedSearchCount: Int, dates: Seq[DailyClickThroughRates]) extends Product with Serializable
GetClickThroughRateResponse
GetClickThroughRateResponse
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.
clickCount
Number of clicks associated with this search.
trackedSearchCount
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
dates
Daily click-through rates.
case class GetConversionRateResponse(rate: Option[Double] = scala.None, trackedSearchCount: Int, conversionCount: Int, dates: Seq[DailyConversionRates]) extends Product with Serializable
GetConversionRateResponse
GetConversionRateResponse
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.
conversionCount
Number of conversions from this search.
dates
Daily conversion rates.
case class GetNoClickRateResponse(rate: Double, count: Int, noClickCount: Int, dates: Seq[DailyNoClickRates]) extends Product with Serializable
GetNoClickRateResponse
GetNoClickRateResponse
rate
No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
count
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
noClickCount
Number of times this search was returned as a result without any click.
dates
Daily no click rates.
case class GetNoResultsRateResponse(rate: Double, count: Int, noResultCount: Int, dates: Seq[DailyNoResultsRates]) extends Product with Serializable
GetNoResultsRateResponse
GetNoResultsRateResponse
rate
No results rate, calculated as number of searches with zero results divided by the total number of searches.
count
Number of searches.
noResultCount
Number of searches without any results.
dates
Daily no results rates.
case class GetPurchaseRateResponse(rate: Option[Double] = scala.None, trackedSearchCount: Int, purchaseCount: Int, dates: Seq[DailyPurchaseRates]) extends Product with Serializable
GetPurchaseRateResponse
GetPurchaseRateResponse
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.
purchaseCount
Number of purchase events from this search.
dates
Daily purchase rates.
case class GetRevenue(currencies: Map[String, CurrenciesValue], dates: Seq[DailyRevenue]) extends Product with Serializable
GetRevenue
GetRevenue
currencies
Revenue associated with this search, broken-down by currencies.
dates
Daily revenue.
case class GetSearchesCountResponse(count: Int, dates: Seq[DailySearches]) extends Product with Serializable
GetSearchesCountResponse
GetSearchesCountResponse
count
Number of occurrences.
dates
Daily number of searches.
case class GetSearchesNoClicksResponse(searches: Seq[DailySearchesNoClicks]) extends Product with Serializable
GetSearchesNoClicksResponse
GetSearchesNoClicksResponse
searches
Searches without any clicks.
case class GetSearchesNoResultsResponse(searches: Seq[DailySearchesNoResults]) extends Product with Serializable
GetSearchesNoResultsResponse
GetSearchesNoResultsResponse
searches
Searches without results.
case class GetStatusResponse(updatedAt: Option[String] = scala.None) extends Product with Serializable
GetStatusResponse
GetStatusResponse
updatedAt
Date and time when the object was updated, in RFC 3339 format.
case class GetTopCountriesResponse(countries: Seq[TopCountry]) extends Product with Serializable
GetTopCountriesResponse
GetTopCountriesResponse
countries
Countries and number of searches.
case class GetTopFilterAttribute(attribute: String, count: Int) extends Product with Serializable
GetTopFilterAttribute
GetTopFilterAttribute
attribute
Attribute name.
count
Number of occurrences.
case class GetTopFilterAttributesResponse(attributes: Seq[GetTopFilterAttribute]) extends Product with Serializable
GetTopFilterAttributesResponse
GetTopFilterAttributesResponse
attributes
Most frequent filters.
case class GetTopFilterForAttribute(attribute: String, operator: Operator, value: String, count: Int) extends Product with Serializable
GetTopFilterForAttribute
GetTopFilterForAttribute
attribute
Attribute name.
value
Attribute value.
count
Number of occurrences.
case class GetTopFilterForAttributeResponse(values: Seq[GetTopFilterForAttribute]) extends Product with Serializable
GetTopFilterForAttributeResponse
GetTopFilterForAttributeResponse
values
Filter values for an attribute.
case class GetTopFiltersNoResultsResponse(values: Option[Seq[GetTopFiltersNoResultsValues]] = scala.None) extends Product with Serializable
GetTopFiltersNoResultsResponse
GetTopFiltersNoResultsResponse
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.
case class GetTopFiltersNoResultsValue(attribute: String, operator: Operator, value: String) extends Product with Serializable
GetTopFiltersNoResultsValue
GetTopFiltersNoResultsValue
attribute
Attribute name.
value
Attribute value.
case class GetTopFiltersNoResultsValues(count: Int, values: Seq[GetTopFiltersNoResultsValue]) extends Product with Serializable
GetTopFiltersNoResultsValues
GetTopFiltersNoResultsValues
count
Number of occurrences.
values
Filters with no results.
sealed trait GetTopHitsResponse extends AnyRef
GetTopHitsResponse
trait GetTopHitsResponseTrait extends GetTopHitsResponse
sealed trait GetTopSearchesResponse extends AnyRef
GetTopSearchesResponse
trait GetTopSearchesResponseTrait extends GetTopSearchesResponse
case class GetUsersCountResponse(count: Int, dates: Seq[DailyUsers]) extends Product with Serializable
GetUsersCountResponse
GetUsersCountResponse
count
Number of unique users.
dates
Daily number of unique users.
sealed trait Operator extends AnyRef
class OperatorSerializer extends CustomSerializer[Operator]
sealed trait OrderBy extends AnyRef
class OrderBySerializer extends CustomSerializer[OrderBy]
case class TopCountry(country: String, count: Int) extends Product with Serializable
TopCountry
TopCountry
country
Country code.
count
Number of occurrences.
case class TopHit(hit: String, count: Int) extends Product with Serializable
TopHit
TopHit
hit
Object ID of a record that's returned as a search result.
count
Number of occurrences.
case class TopHitWithAnalytics(hit: String, count: Int, clickThroughRate: Option[Double] = scala.None, conversionRate: Option[Double] = scala.None, trackedHitCount: Int, clickCount: Int, conversionCount: Int) extends Product with Serializable
TopHitWithAnalytics
TopHitWithAnalytics
hit
Object ID of a record that's returned as a search result.
count
Number of occurrences.
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.
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.
trackedHitCount
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
clickCount
Number of clicks associated with this search.
conversionCount
Number of conversions from this search.
case class TopHitWithRevenueAnalytics(hit: String, count: Int, clickThroughRate: Option[Double] = scala.None, conversionRate: Option[Double] = scala.None, trackedHitCount: Int, clickCount: Int, conversionCount: Int, addToCartRate: Option[Double] = scala.None, addToCartCount: Int, purchaseRate: Option[Double] = scala.None, purchaseCount: Int, currencies: Map[String, CurrenciesValue]) extends Product with Serializable
TopHitWithRevenueAnalytics
TopHitWithRevenueAnalytics
hit
Object ID of a record that's returned as a search result.
count
Number of occurrences.
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.
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.
trackedHitCount
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
clickCount
Number of clicks associated with this search.
conversionCount
Number of conversions 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.
addToCartCount
Number of add-to-cart 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.
purchaseCount
Number of purchase events from this search.
currencies
Revenue associated with this search, broken-down by currencies.
case class TopHitsResponse(hits: Seq[TopHit]) extends GetTopHitsResponseTrait with Product with Serializable
TopHitsResponse
TopHitsResponse
hits
Most frequent search results.
case class TopHitsResponseWithAnalytics(hits: Seq[TopHitWithAnalytics]) extends GetTopHitsResponseTrait with Product with Serializable
TopHitsResponseWithAnalytics
TopHitsResponseWithAnalytics
hits
Most frequent search results with click and conversion metrics.
case class TopHitsResponseWithRevenueAnalytics(hits: Seq[TopHitWithRevenueAnalytics]) extends GetTopHitsResponseTrait with Product with Serializable
TopHitsResponseWithRevenueAnalytics
TopHitsResponseWithRevenueAnalytics
hits
Most frequent search results with click, conversion, and revenue metrics.
case class TopSearch(search: String, count: Int, nbHits: Int) extends Product with Serializable
TopSearch
TopSearch
search
Search query.
count
Number of searches.
nbHits
Number of results (hits).
case class TopSearchWithAnalytics(search: String, count: Int, clickThroughRate: Option[Double] = scala.None, averageClickPosition: Option[Double] = scala.None, clickPositions: Seq[ClickPosition], conversionRate: Option[Double] = scala.None, trackedSearchCount: Int, clickCount: Int, conversionCount: Int, nbHits: Int) extends Product with Serializable
TopSearchWithAnalytics
TopSearchWithAnalytics
search
Search query.
count
Number of searches.
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.
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.
clickPositions
List of positions in the search results and clicks associated with 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.
trackedSearchCount
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
clickCount
Number of clicks associated with this search.
conversionCount
Number of conversions from this search.
nbHits
Number of results (hits).
case class TopSearchWithRevenueAnalytics(search: String, count: Int, clickThroughRate: Option[Double] = scala.None, averageClickPosition: Option[Double] = scala.None, clickPositions: Seq[ClickPosition], conversionRate: Option[Double] = scala.None, trackedSearchCount: Int, clickCount: Int, conversionCount: Int, nbHits: Int, currencies: Map[String, CurrenciesValue], addToCartRate: Option[Double] = scala.None, addToCartCount: Int, purchaseRate: Option[Double] = scala.None, purchaseCount: Int) extends Product with Serializable
TopSearchWithRevenueAnalytics
TopSearchWithRevenueAnalytics
search
Search query.
count
Number of searches.
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.
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.
clickPositions
List of positions in the search results and clicks associated with 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.
trackedSearchCount
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
clickCount
Number of clicks associated with this search.
conversionCount
Number of conversions from this search.
nbHits
Number of results (hits).
currencies
Revenue associated with this search, broken-down by currencies.
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.
addToCartCount
Number of add-to-cart 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.
purchaseCount
Number of purchase events from this search.
case class TopSearchesResponse(searches: Seq[TopSearch]) extends GetTopSearchesResponseTrait with Product with Serializable
TopSearchesResponse
TopSearchesResponse
searches
Most popular searches and their number of search results (hits).
case class TopSearchesResponseWithAnalytics(searches: Seq[TopSearchWithAnalytics]) extends GetTopSearchesResponseTrait with Product with Serializable
TopSearchesResponseWithAnalytics
TopSearchesResponseWithAnalytics
searches
Most popular searches and their associated click and conversion metrics.
case class TopSearchesResponseWithRevenueAnalytics(searches: Seq[TopSearchWithRevenueAnalytics]) extends GetTopSearchesResponseTrait with Product with Serializable
TopSearchesResponseWithRevenueAnalytics
TopSearchesResponseWithRevenueAnalytics
searches
Most popular searches, including their click and revenue metrics.

Value Members

object Direction
Direction enumeration
object GetTopHitsResponse
object GetTopHitsResponseSerializer extends Serializer[GetTopHitsResponse]
object GetTopSearchesResponse
object GetTopSearchesResponseSerializer extends Serializer[GetTopSearchesResponse]
object JsonSupport
object Operator
Character that characterizes how the filter is applied.
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.
object OrderBy
Attribute by which to order the response items.
Attribute by which to order the response items. If the clickAnalytics parameter is false, only searchCount is available.

Packages

analytics

package analytics

Type Members

Value Members

Ungrouped

Packages

analytics

package analytics

Type Members

Value Members

Ungrouped

analytics