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: Option[Double], conversionSignificance: Option[Double], addToCartSignificance: Option[Double], purchaseSignificance: Option[Double], revenueSignificance: Option[Map[String, Double]], updatedAt: String, createdAt: String, endAt: String, name: String, status: Status, variants: Seq[Variant], configuration: Option[ABTestConfiguration])

ABTest

ABTest

Value parameters

abTestID

Unique A/B test identifier.

createdAt

Date and time when the A/B test was created, in RFC 3339 format.

endAt

End date and time of the A/B test, in RFC 3339 format.

name

A/B test name.

updatedAt

Date and time when the A/B test was last updated, in RFC 3339 format.

variants

A/B test variants. The first variant is your control index, typically your production index. The second variant is an index with changed settings that you want to test against the control.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ABTestConfiguration(outliers: Outliers, emptySearch: Option[EmptySearch], minimumDetectableEffect: Option[MinimumDetectableEffect])

A/B test configuration.

A/B test configuration.

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 identifier.

index

Index name of the A/B test variant (case-sensitive).

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

Description for this variant.

index

Index name of the A/B test variant (case-sensitive).

trafficPercentage

Percentage of search requests each variant receives.

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

Description for this variant.

index

Index name of the A/B test variant (case-sensitive).

trafficPercentage

Percentage of search requests each variant receives.

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 and time of the A/B test, in RFC 3339 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 Currency(currency: Option[String], revenue: Option[Double], mean: Option[Double], standardDeviation: Option[Double])

Currency

Currency

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)

Search parameters to add to the test variant. Only use this parameter if the two variants use the same index.

Search parameters to add to the test variant. 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
sealed trait Effect

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AddToCartRate.type
object ClickThroughRate.type
object ConversionRate.type
object PurchaseRate.type
object Effect

Metric for which you want to detect the smallest relative difference.

Metric for which you want to detect the smallest relative difference.

Attributes

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

Attributes

Supertypes
class CustomSerializer[Effect]
trait Serializer[Effect]
class Object
trait Matchable
class Any
case class EmptySearch(exclude: Option[Boolean])

Configuration for handling empty searches.

Configuration for handling empty searches.

Value parameters

exclude

Whether to exclude empty searches when calculating A/B test results.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EmptySearchFilter(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 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[OutliersFilter], emptySearch: Option[EmptySearchFilter])

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
object JsonSupport

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class ListABTestsResponse(abtests: Option[Seq[ABTest]], count: Int, total: Int)

ListABTestsResponse

ListABTestsResponse

Value parameters

abtests

A/B tests.

count

Number of A/B tests.

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 MinimumDetectableEffect(size: Option[Double], effect: Option[Effect])

Configuration for the smallest difference between test variants you want to detect.

Configuration for the smallest difference between test variants you want to detect.

Value parameters

size

Smallest difference in an observable metric between variants. For example, to detect a 10% difference between variants, set this value to 0.1.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Outliers(exclude: Option[Boolean])

Configuration for handling outliers.

Configuration for handling outliers.

Value parameters

exclude

Whether to exclude outliers when calculating A/B test results.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OutliersFilter(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
sealed trait Status

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Active.type
object Expired.type
object Failed.type
object Stopped.type
object Status

A/B test status. - active. The A/B test is live and search traffic is split between the two variants. - stopped. You stopped the A/B test. The A/B test data is still available for analysis. - expired. The A/B test was automatically stopped after reaching its end date. - failed. Creating the A/B test failed.

A/B test status. - active. The A/B test is live and search traffic is split between the two variants. - stopped. You stopped the A/B test. The A/B test data is still available for analysis. - expired. The A/B test was automatically stopped after reaching its end date. - failed. Creating the A/B test failed.

Attributes

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

Attributes

Supertypes
class CustomSerializer[Status]
trait Serializer[Status]
class Object
trait Matchable
class Any
case class Variant(addToCartCount: Int, addToCartRate: Option[Double], averageClickPosition: Option[Int], clickCount: Int, clickThroughRate: Option[Double], conversionCount: Int, conversionRate: Option[Double], currencies: Option[Map[String, Currency]], description: String, estimatedSampleSize: Option[Int], filterEffects: Option[FilterEffects], index: String, noResultCount: Option[Int], purchaseCount: Int, purchaseRate: Option[Double], searchCount: Option[Int], trackedSearchCount: Option[Int], trafficPercentage: Int, userCount: Option[Int], trackedUserCount: Option[Int])

Variant

Variant

Value parameters

addToCartCount

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

addToCartRate

Add-to-cart rate for this variant.

averageClickPosition

Average click position for this variant.

clickCount

Number of click events for this variant.

clickThroughRate

Click-through rate for this variant.

conversionCount

Number of click events for this variant.

conversionRate

Conversion rate for this variant.

currencies

A/B test currencies.

description

Description for this variant.

estimatedSampleSize

Estimated number of searches required to achieve the desired statistical significance. The A/B test configuration must include a mininmumDetectableEffect setting for this number to be included in the response.

index

Index name of the A/B test variant (case-sensitive).

noResultCount

Number of searches without results for this variant.

purchaseCount

Number of purchase events for this variant.

purchaseRate

Purchase rate for this variant.

searchCount

Number of searches for this variant.

trackedSearchCount

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

trackedUserCount

Number of users that made tracked searches to this variant.

trafficPercentage

Percentage of search requests each variant receives.

userCount

Number of users that made searches to this variant.

Attributes

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