A/B testing API client methods

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

List of methods

Add A/B test addABTest addABTest addABTest add_ab_test add_ab_test AddABTest addABTest AddABTest addABTest add abTest	Create an A/B test.
Get A/B test getABTest getABTest getABTest get_ab_test get_ab_test GetABTest getABTest GetABTest getABTest get abTest	Get an A/B test information and results.
List A/B tests getABTests getABTests getABTests get_ab_tests get_ab_tests GetABTests getABTests GetABTests List A/B tests get all abTests	List A/B tests information and results.
Stop A/B test stopABTest stopABTest stopABTest stop_ab_test stop_ab_test StopABTest stopABTest StopABTest stopABTest stop abTest	Stop an A/B test
Delete A/B test deleteABTest deleteABTest deleteABTest delete_ab_test delete_ab_test DeleteABTest deleteABTest DeleteABTest deleteABTest delete abTest	Delete an A/B test

Guide What is A/B testing

A/B testing region

Your Analytics data is stored and processed in a specific region: either in Europe (Germany), or in the United States. When initializing the Analytics client, you need to select your analytics region:

Copy

1
2
3
4
5
6
7
8
use Algolia\AlgoliaSearch\AnalyticsClient;

// You need an API key with `setSettings` permissions
$analytics = AnalyticsClient::create(
    'YourApplicationID',
    'YourAPIKey',
    'de' // Default: "us"
);

1
2
3
4
5
6
7
8
require 'algolia'

# You need an API key with `setSettings` permissions
analytics = Algolia::Analytics::Client.create(
  'YourApplicationID',
  'YourAPIKey',
  'de'  # Default: 'us'
)

1
2
3
4
5
6
7
8
9
const algoliasearch = require('algoliasearch');

// You need an API key with `setSettings` permissions
const client = algoliasearch('YourApplicationID', 'YourAPIKey');
const analytics = client.initAnalytics({
  appId: 'YourApplicationID',
  apiKey: 'YourAPIKey',
  region: 'de' // Default: 'us'
});

1
2
3
4
5
6
7
8
from algoliasearch.analytics_client import AnalyticsClient

# You need an API key with `setSettings` permissions
analytics = AnalyticsClient.create(
    "YourApplicationID",
    "YourAPIKey",
    "de"  # Default: "us"
)

1
2
3
4
5
6
7
8
import AlgoliaSearchClient

// You need an API key with `setSettings` permissions
let client = AnalyticsClient(
  appID: "YourApplicationID",
  apiKey: "YourAPIKey",
  region: .de // Default: .us
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import com.algolia.search.model.APIKey
import com.algolia.search.model.ApplicationID
import com.algolia.search.client.ClientAnalytics
import com.algolia.search.configuration.Region.Analytics.EU
// import.com.algolia.search.configuration.Region.Analytics.US

suspend fun main() {
  // You need an API key with `setSettings` permission
  val client = ClientAnalytics(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourAPIKey"),
    region = EU // default: US
  )
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
using Algolia.Search.Clients;

class Program
{
  public static void Main(string[] args)
  {
    // You need an API key with `setSettings` permissions
    var client = new AnalyticsClient(
      "YourApplicationID",
      "YourAPIKey",
      "de", // Default: "us"
    )
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
import com.algolia.search.DefaultAnalyticsClient;
import com.algolia.search.AnalyticsClient;

public class Program {
  public static void main(String[] args) {
    // You need an API key with `setSettings` permissions
    AnalyticsClient client = DefaultAnalyticsClient.create(
      "YourApplicationID",
      "YourAPIKey",
      "de" // Default: "us"
    );
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
package main

import (
  "github.com/algolia/algoliasearch-client-go/v3/algolia/analytics"
  "github.com/algolia/algoliasearch-client-go/v3/algolia/region"
)

func main() {
  // You need an API key with `setSettings` permissions
  client := analytics.NewClientWithConfig(
    analytics.Configuration{
      AppID:  "YourApplicationID",
      APIKey: "YourAPIKey",
      Region: region.DE, // Default: `region.US`
    },
  )
}

You can check the region for your account in the Algolia dashboard.

Did you find this page helpful?

A/B testing API client methods

A/B testing region

On this page