algoliasearch.abtesting
Members list
Type members
Classlikes
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 thistaskID
.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
AbTestsVariant
AbTestsVariant
Value parameters
- description
-
A/B test description.
- index
-
A/B test index.
- trafficPercentage
-
A/B test traffic percentage.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AddABTestsVariantTraittrait AddABTestsVariantclass Objecttrait Matchableclass AnyShow all
AbTestsVariantSearchParams
AbTestsVariantSearchParams
Value parameters
- description
-
A/B test description.
- index
-
A/B test index.
- trafficPercentage
-
A/B test traffic percentage.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AddABTestsVariantTraittrait AddABTestsVariantclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
AddABTestsVariant
AddABTestsVariant
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
AddABTestsVariant.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class AbTestsVariant
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Error.
Error.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
A/B test filter effects resulting from configuration settings.
A/B test filter effects resulting from configuration settings.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
JsonSupport.type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 istrue
. - trafficPercentage
-
A/B test traffic percentage.
- userCount
-
Number of users during the A/B test.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all