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

algoliasearch.abtesting

package algoliasearch.abtesting

Members list

Type members

Classlikes

case class ABTest(abTestID: Int, clickSignificance: Double, conversionSignificance: Double, addToCartSignificance: Double, purchaseSignificance: Double, revenueSignificance: Map[String, Double], updatedAt: String, createdAt: String, endAt: String, name: String, status: String, variants: Seq[Variant])

ABTest

ABTest

Value parameters

abTestID

Unique A/B test ID.

addToCartSignificance

A/B test significance based on add-to-cart data. A value of 0.95 or over is considered to be significant.

clickSignificance

A/B test significance based on click data. A value of 0.95 or over is considered to be significant.

conversionSignificance

A/B test significance based on conversion. A value of 0.95 or over is considered to be significant.

createdAt

Creation date timestamp in ISO-8601 format.

endAt

End date timestamp in ISO-8601 format.

name

A/B test name.

purchaseSignificance

A/B test significance based on purchase data. A value of 0.95 or over is considered to be significant.

revenueSignificance

A/B test significance based on revenue data. A value of 0.95 or over is considered to be significant.

status

A/B test status.

updatedAt

Update date timestamp in ISO-8601 format.

variants

A/B test variants.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ABTestResponse(index: String, abTestID: Int, taskID: Long)

ABTestResponse

ABTestResponse

Value parameters

abTestID

Unique A/B test ID.

index

A/B test index.

taskID

Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this taskID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AbTestsVariant(index: String, trafficPercentage: Int, description: Option[String]) extends AddABTestsVariantTrait

AbTestsVariant

AbTestsVariant

Value parameters

description

A/B test description.

index

A/B test index.

trafficPercentage

A/B test traffic percentage.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AbTestsVariantSearchParams(index: String, trafficPercentage: Int, description: Option[String], customSearchParameters: Any) extends AddABTestsVariantTrait

AbTestsVariantSearchParams

AbTestsVariantSearchParams

Value parameters

description

A/B test description.

index

A/B test index.

trafficPercentage

A/B test traffic percentage.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AddABTestsRequest(name: String, variants: Seq[AddABTestsVariant], endAt: String)

AddABTestsRequest

AddABTestsRequest

Value parameters

endAt

End date timestamp in ISO-8601 format.

name

A/B test name.

variants

A/B test variants.

Attributes

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

AddABTestsVariant

AddABTestsVariant

Attributes

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object AddABTestsVariantSerializer extends Serializer[AddABTestsVariant]

Attributes

Supertypes
trait Serializer[AddABTestsVariant]
class Object
trait Matchable
class Any
Self type
trait AddABTestsVariantTrait extends AddABTestsVariant

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class CurrenciesValue(currency: Option[String], revenue: Option[Double], mean: Option[Double], standardDeviation: Option[Double])

CurrenciesValue

CurrenciesValue

Value parameters

currency

Currency code.

mean

Mean for this currency.

revenue

Revenue for this currency.

standardDeviation

Standard deviation for this currency.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class CustomSearchParams(customSearchParameters: Any)

Applies search parameters from a restricted set of options. Only use this parameter if the two variants use the same index.

Applies search parameters from a restricted set of options. Only use this parameter if the two variants use the same index.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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 FilterEffects(outliers: Option[FilterEffectsOutliers], emptySearch: Option[FilterEffectsEmptySearch])

A/B test filter effects resulting from configuration settings.

A/B test filter effects resulting from configuration settings.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class FilterEffectsEmptySearch(usersCount: Option[Int], trackedSearchesCount: Option[Int])

Empty searches removed from the A/B test as a result of configuration settings.

Empty searches removed from the A/B test as a result of configuration settings.

Value parameters

trackedSearchesCount

Number of tracked searches removed from the A/B test.

usersCount

Number of users removed from the A/B test.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class FilterEffectsOutliers(usersCount: Option[Int], trackedSearchesCount: Option[Int])

Outliers removed from the A/B test as a result of configuration settings.

Outliers removed from the A/B test as a result of configuration settings.

Value parameters

trackedSearchesCount

Number of tracked searches removed from the A/B test.

usersCount

Number of users removed from the A/B test.

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 ListABTestsResponse(abtests: Seq[ABTest], count: Int, total: Int)

ListABTestsResponse

ListABTestsResponse

Value parameters

abtests

A/B tests.

count

Number of A/B tests implemented.

total

Number of retrievable A/B tests.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Variant(addToCartCount: Int, addToCartRate: Double, averageClickPosition: Int, clickCount: Int, clickThroughRate: Double, conversionCount: Int, conversionRate: Double, currencies: Map[String, CurrenciesValue], description: String, filterEffects: Option[FilterEffects], index: String, noResultCount: Int, purchaseCount: Int, purchaseRate: Double, searchCount: Int, trackedSearchCount: Int, trafficPercentage: Int, userCount: Int)

Variant

Variant

Value parameters

addToCartCount

Number of add-to-cart events for this variant.

addToCartRate

Variant's add-to-cart rate.

averageClickPosition

Variant's average click position.

clickCount

Number of click events for this variant.

clickThroughRate

Variant's click-through rate.

conversionCount

Number of click events for this variant.

conversionRate

Variant's conversion rate.

currencies

A/B test currencies.

description

A/B test description.

index

A/B test index.

noResultCount

Number of searches without results for that variant.

purchaseCount

Number of purchase events for this variant.

purchaseRate

Variant's purchase rate.

searchCount

Number of searches carried out during the A/B test.

trackedSearchCount

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

trafficPercentage

A/B test traffic percentage.

userCount

Number of users during the A/B test.

Attributes

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