AbtestingClient

algoliasearch.api.AbtestingClient
See theAbtestingClient companion object
class AbtestingClient(appId: String, apiKey: String, region: Option[String], clientOptions: ClientOptions) extends ApiClient

Attributes

Companion
object
Graph
Supertypes
class ApiClient
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def addABTests(addABTestsRequest: AddABTestsRequest, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ABTestResponse]

Creates a new A/B test.

Creates a new A/B test.

Required API Key ACLs:

  • editSettings

Attributes

def customDelete[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customGet[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$2: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPost[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$3: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPut[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$4: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def deleteABTest(id: Int, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ABTestResponse]

Deletes an A/B test by its ID.

Deletes an A/B test by its ID.

Required API Key ACLs:

  • editSettings

Value parameters

id

Unique A/B test identifier.

Attributes

def getABTest(id: Int, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ABTest]

Retrieves the details for an A/B test by its ID.

Retrieves the details for an A/B test by its ID.

Required API Key ACLs:

  • analytics

Value parameters

id

Unique A/B test identifier.

Attributes

def listABTests(offset: Option[Int], limit: Option[Int], indexPrefix: Option[String], indexSuffix: Option[String], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ListABTestsResponse]

Lists all A/B tests you configured for this application.

Lists all A/B tests you configured for this application.

Required API Key ACLs:

  • analytics

Value parameters

indexPrefix

Index name prefix. Only A/B tests for indices starting with this string are included in the response.

indexSuffix

Index name suffix. Only A/B tests for indices ending with this string are included in the response.

limit

Number of items to return.

offset

Position of the first item to return.

Attributes

def stopABTest(id: Int, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ABTestResponse]

Stops an A/B test by its ID. You can't restart stopped A/B tests.

Stops an A/B test by its ID. You can't restart stopped A/B tests.

Required API Key ACLs:

  • editSettings

Value parameters

id

Unique A/B test identifier.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient