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 an A/B test.

Creates an A/B test.

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]

Delete an A/B test. To determine the id for an A/B test, use the listABTests operation.

Delete an A/B test. To determine the id for an A/B test, use the listABTests operation.

Value parameters

id

Unique A/B test ID.

Attributes

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

Get specific details for an A/B test. To determine the id for an A/B test, use the listABTests operation.

Get specific details for an A/B test. To determine the id for an A/B test, use the listABTests operation.

Value parameters

id

Unique A/B test ID.

Attributes

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

List all A/B tests.

List all A/B tests.

Value parameters

indexPrefix

Only return A/B tests for indices starting with this prefix.

indexSuffix

Only return A/B tests for indices ending with this suffix.

limit

Number of records to return (page size).

offset

Position of the starting record. Used for paging. 0 is the first record.

Attributes

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

If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the id for an A/B test, use the listABTests operation.

If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the id for an A/B test, use the listABTests operation.

Value parameters

id

Unique A/B test ID.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient