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

algoliasearch.analytics

package algoliasearch.analytics

Members list

Type members

Classlikes

case class AverageClickEvent(average: Double, clickCount: Int, date: String)

AverageClickEvent

AverageClickEvent

Value parameters

average

Average count of all click events.

clickCount

Number of click events.

date

Date of the event in the format YYYY-MM-DD.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ClickPosition(position: Seq[Int], clickCount: Int)

ClickPosition

ClickPosition

Value parameters

clickCount

Number of click events.

position

Range of positions with the following pattern: - For positions 1 to 10, the number of click events are shown for each position - For positions 11 to 20, all click events are grouped - For positions 21 and up, all click events are grouped.

Attributes

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

ClickThroughRateEvent

ClickThroughRateEvent

Value parameters

clickCount

Number of click events.

date

Date of the event in the format YYYY-MM-DD.

rate

Click-through rate (CTR).

trackedSearchCount

Number of tracked searches. This is the number of 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 ConversionRateEvent(rate: Double, trackedSearchCount: Int, conversionCount: Int, date: String)

ConversionRateEvent

ConversionRateEvent

Value parameters

conversionCount

Number of converted clicks.

date

Date of the event in the format YYYY-MM-DD.

rate

Click-through rate (CTR).

trackedSearchCount

Number of tracked searches. This is the number of search requests where the clickAnalytics parameter is true.

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 GetAverageClickPositionResponse(average: Double, clickCount: Int, dates: Seq[AverageClickEvent])

GetAverageClickPositionResponse

GetAverageClickPositionResponse

Value parameters

average

Average count of all click events.

clickCount

Number of click events.

dates

Average click positions.

Attributes

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

GetClickPositionsResponse

GetClickPositionsResponse

Value parameters

positions

Click positions.

Attributes

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

GetClickThroughRateResponse

GetClickThroughRateResponse

Value parameters

clickCount

Number of click events.

dates

Click-through rate events.

rate

Click-through rate (CTR).

trackedSearchCount

Number of tracked searches. This is the number of 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 GetConversationRateResponse(rate: Double, trackedSearchCount: Int, conversionCount: Int, dates: Seq[ConversionRateEvent])

GetConversationRateResponse

GetConversationRateResponse

Value parameters

conversionCount

Number of converted clicks.

dates

Conversion events.

rate

Click-through rate (CTR).

trackedSearchCount

Number of tracked searches. This is the number of 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[NoClickRateEvent])

GetNoClickRateResponse

GetNoClickRateResponse

Value parameters

count

Number of click events.

dates

Overall count of searches without clicks plus a daily breakdown.

noClickCount

Number of click events.

rate

Click-through rate (CTR).

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[NoResultsRateEvent])

GetNoResultsRateResponse

GetNoResultsRateResponse

Value parameters

count

Number of occurrences.

dates

Overall count of searches without results plus a daily breakdown.

noResultCount

Number of occurrences.

rate

Click-through rate (CTR).

Attributes

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

GetSearchesCountResponse

GetSearchesCountResponse

Value parameters

count

Number of occurrences.

dates

Search events with their associated dates and hit counts.

Attributes

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

GetSearchesNoClicksResponse

GetSearchesNoClicksResponse

Value parameters

searches

Searches with no clicks.

Attributes

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

GetSearchesNoResultsResponse

GetSearchesNoResultsResponse

Value parameters

searches

Searches with no results.

Attributes

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

GetStatusResponse

GetStatusResponse

Value parameters

updatedAt

Timestamp of the last update in ISO 8601 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

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

Filterable attributes.

Attributes

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

GetTopFilterForAttribute

GetTopFilterForAttribute

Value parameters

attribute

Attribute name.

count

Number of occurrences.

operator

Operator.

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: Seq[GetTopFiltersNoResultsValues])

GetTopFiltersNoResultsResponse

GetTopFiltersNoResultsResponse

Value parameters

values

Filters with no results.

Attributes

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

GetTopFiltersNoResultsValue

GetTopFiltersNoResultsValue

Value parameters

attribute

Attribute name.

operator

Operator.

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[UserWithDate])

GetUsersCountResponse

GetUsersCountResponse

Value parameters

count

Number of occurrences.

dates

User count.

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
case class NoClickRateEvent(rate: Double, count: Int, noClickCount: Int, date: String)

NoClickRateEvent

NoClickRateEvent

Value parameters

count

Number of tracked and untracked searches (where the clickAnalytics parameter isn't true).

date

Date of the event in the format YYYY-MM-DD.

noClickCount

Number of click events.

rate

Click-through rate (CTR).

Attributes

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

NoResultsRateEvent

NoResultsRateEvent

Value parameters

count

Number of tracked and untracked searches (where the clickAnalytics parameter isn't true).

date

Date of the event in the format YYYY-MM-DD.

noResultCount

Number of occurences.

rate

Click-through rate (CTR).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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

Method for ordering results. clickThroughRate, conversionRate and averageClickPosition are only available if the clickAnalytics parameter is true.

Method for ordering results. clickThroughRate, conversionRate and averageClickPosition are only available if the clickAnalytics parameter is true.

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 SearchEvent(date: String, count: Int)

SearchEvent

SearchEvent

Value parameters

count

Number of occurrences.

date

Date of the event in the format YYYY-MM-DD.

Attributes

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

SearchNoClickEvent

SearchNoClickEvent

Value parameters

count

Number of occurrences.

search

User query.

withFilterCount

Number of occurrences.

Attributes

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

SearchNoResultEvent

SearchNoResultEvent

Value parameters

count

Number of occurrences.

nbHits

Number of hits the search query matched.

search

User query.

Attributes

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

TopCountry

TopCountry

Value parameters

count

Number of occurrences.

country

Country.

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

Hit.

Attributes

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

TopHitWithAnalytics

TopHitWithAnalytics

Value parameters

clickCount

Number of click events.

clickThroughRate

Click-through rate (CTR).

conversionCount

Number of converted clicks.

conversionRate

Conversion rate (CR).

count

Number of occurrences.

hit

Hit.

trackedSearchCount

Number of tracked searches. This is the number of 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

Top hits.

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

Top hits.

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 tracked and untracked searches (where the clickAnalytics parameter isn't true).

nbHits

Number of hits the search query matched.

search

User 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: Double, averageClickPosition: Int, conversionRate: Double, trackedSearchCount: Int, clickCount: Int, conversionCount: Int, nbHits: Int)

TopSearchWithAnalytics

TopSearchWithAnalytics

Value parameters

averageClickPosition

Average position of clicked search result.

clickCount

Number of click events.

clickThroughRate

Click-through rate (CTR).

conversionCount

Number of converted clicks.

conversionRate

Conversion rate (CR).

count

Number of tracked and untracked searches (where the clickAnalytics parameter isn't true).

nbHits

Number of hits the search query matched.

search

User query.

trackedSearchCount

Number of tracked searches. This is the number of 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

Top searches with their hits count.

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

Top searches with their hits count and analytics.

Attributes

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

UserWithDate

UserWithDate

Value parameters

count

Number of occurrences.

date

Date of the event in the format YYYY-MM-DD.

Attributes

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