launchdarkly_api.ExperimentsApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
create_experiment	POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments	Create experiment
create_iteration	POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations	Create iteration
get_experiment	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}	Get experiment
get_experiment_results	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results	Get experiment results
get_experiment_results_for_metric_group	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metric-groups/{metricGroupKey}/results	Get experiment results for metric group
get_experimentation_settings	GET /api/v2/projects/{projectKey}/experimentation-settings	Get experimentation settings
get_experiments	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments	Get experiments
get_legacy_experiment_results	GET /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}	Get legacy experiment results (deprecated)
patch_experiment	PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}	Patch experiment
put_experimentation_settings	PUT /api/v2/projects/{projectKey}/experimentation-settings	Update experimentation settings

create_experiment

Experiment create_experiment(project_key, environment_key, experiment_post)

Create experiment

Create an experiment. To run this experiment, you'll need to create an iteration and then update the experiment with the startIteration instruction. To learn more, read Creating experiments.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.experiment import Experiment
from launchdarkly_api.model.experiment_post import ExperimentPost
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    experiment_post = ExperimentPost(
        name="Example experiment",
        description="An example experiment, used in testing",
        maintainer_id="12ab3c45de678910fgh12345",
        key="experiment-key-123abc",
        iteration=IterationInput(
            hypothesis="Example hypothesis, the new button placement will increase conversion",
            can_reshuffle_traffic=True,
            metrics=MetricsInput([
                MetricInput(
                    key="metric-key-123abc",
                    is_group=True,
                    primary=True,
                ),
            ]),
            primary_single_metric_key="metric-key-123abc",
            primary_funnel_key="metric-group-key-123abc",
            treatments=TreatmentsInput([
                TreatmentInput(
                    name="Treatment 1",
                    baseline=True,
                    allocation_percent="10",
                    parameters=[
                        TreatmentParameterInput(
                            flag_key="example-flag-for-experiment",
                            variation_id="e432f62b-55f6-49dd-a02f-eb24acf39d05",
                        ),
                    ],
                ),
            ]),
            flags=FlagsInput(
                key=FlagInput(
                    rule_id="e432f62b-55f6-49dd-a02f-eb24acf39d05",
                    flag_config_version=12,
                    not_in_experiment_variation_id="e432f62b-55f6-49dd-a02f-eb24acf39d05",
                ),
            ),
            randomization_unit="user",
            attributes=["country","device","os"],
        ),
        holdout_id="f3b74309-d581-44e1-8a2b-bb2933b4fe40",
    ) # ExperimentPost | 

    # example passing only required values which don't have defaults set
    try:
        # Create experiment
        api_response = api_instance.create_experiment(project_key, environment_key, experiment_post)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->create_experiment: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
experiment_post	ExperimentPost

Return type

Experiment

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Experiment response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iteration

IterationRep create_iteration(project_key, environment_key, experiment_key, iteration_input)

Create iteration

Create an experiment iteration. Experiment iterations let you record experiments in individual blocks of time. Initially, iterations are created with a status of not_started and appear in the draftIteration field of an experiment. To start or stop an iteration, update the experiment with the startIteration or stopIteration instruction. To learn more, read Start experiment iterations.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.iteration_rep import IterationRep
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.iteration_input import IterationInput
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    experiment_key = "experimentKey_example" # str | The experiment key
    iteration_input = IterationInput(
        hypothesis="Example hypothesis, the new button placement will increase conversion",
        can_reshuffle_traffic=True,
        metrics=MetricsInput([
            MetricInput(
                key="metric-key-123abc",
                is_group=True,
                primary=True,
            ),
        ]),
        primary_single_metric_key="metric-key-123abc",
        primary_funnel_key="metric-group-key-123abc",
        treatments=TreatmentsInput([
            TreatmentInput(
                name="Treatment 1",
                baseline=True,
                allocation_percent="10",
                parameters=[
                    TreatmentParameterInput(
                        flag_key="example-flag-for-experiment",
                        variation_id="e432f62b-55f6-49dd-a02f-eb24acf39d05",
                    ),
                ],
            ),
        ]),
        flags=FlagsInput(
            key=FlagInput(
                rule_id="e432f62b-55f6-49dd-a02f-eb24acf39d05",
                flag_config_version=12,
                not_in_experiment_variation_id="e432f62b-55f6-49dd-a02f-eb24acf39d05",
            ),
        ),
        randomization_unit="user",
        attributes=["country","device","os"],
    ) # IterationInput | 

    # example passing only required values which don't have defaults set
    try:
        # Create iteration
        api_response = api_instance.create_iteration(project_key, environment_key, experiment_key, iteration_input)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->create_iteration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
experiment_key	str	The experiment key
iteration_input	IterationInput

Return type

IterationRep

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Iteration response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_experiment

Experiment get_experiment(project_key, environment_key, experiment_key)

Get experiment

Get details about an experiment. ### Expanding the experiment response LaunchDarkly supports four fields for expanding the "Get experiment" response. By default, these fields are not included in the response. To expand the response, append the expand query parameter and add a comma-separated list with any of the following fields: - previousIterations includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - draftIteration includes the iteration which has not been started yet, if any. - secondaryMetrics includes secondary metrics. By default only the primary metric is included in the response. - treatments includes all treatment and parameter details. By default treatment data is not included in the response. For example, expand=draftIteration,treatments includes the draftIteration and treatments fields in the response. If fields that you request with the expand query parameter are empty, they are not included in the response.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.experiment import Experiment
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.method_not_allowed_error_rep import MethodNotAllowedErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    experiment_key = "experimentKey_example" # str | The experiment key
    expand = "expand_example" # str | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get experiment
        api_response = api_instance.get_experiment(project_key, environment_key, experiment_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiment: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get experiment
        api_response = api_instance.get_experiment(project_key, environment_key, experiment_key, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiment: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
experiment_key	str	The experiment key
expand	str	A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.	[optional]

Return type

Experiment

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experiment response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_experiment_results

ExperimentBayesianResultsRep get_experiment_results(project_key, environment_key, experiment_key, metric_key)

Get experiment results

Get results from an experiment for a particular metric. LaunchDarkly supports one field for expanding the "Get experiment results" response. By default, this field is not included in the response. To expand the response, append the expand query parameter with the following field: * traffic includes the total count of units for each treatment. For example, expand=traffic includes the traffic field for the project in the response.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.experiment_bayesian_results_rep import ExperimentBayesianResultsRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    experiment_key = "experimentKey_example" # str | The experiment key
    metric_key = "metricKey_example" # str | The metric key
    iteration_id = "iterationId_example" # str | The iteration ID (optional)
    expand = "expand_example" # str | A comma-separated list of fields to expand in the response. Supported fields are explained above. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get experiment results
        api_response = api_instance.get_experiment_results(project_key, environment_key, experiment_key, metric_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiment_results: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get experiment results
        api_response = api_instance.get_experiment_results(project_key, environment_key, experiment_key, metric_key, iteration_id=iteration_id, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiment_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
experiment_key	str	The experiment key
metric_key	str	The metric key
iteration_id	str	The iteration ID	[optional]
expand	str	A comma-separated list of fields to expand in the response. Supported fields are explained above.	[optional]

Return type

ExperimentBayesianResultsRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experiment results response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_experiment_results_for_metric_group

MetricGroupResultsRep get_experiment_results_for_metric_group(project_key, environment_key, experiment_key, metric_group_key)

Get experiment results for metric group

Get results from an experiment for a particular metric group.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.metric_group_results_rep import MetricGroupResultsRep
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    experiment_key = "experimentKey_example" # str | The experiment key
    metric_group_key = "metricGroupKey_example" # str | The metric group key
    iteration_id = "iterationId_example" # str | The iteration ID (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get experiment results for metric group
        api_response = api_instance.get_experiment_results_for_metric_group(project_key, environment_key, experiment_key, metric_group_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiment_results_for_metric_group: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get experiment results for metric group
        api_response = api_instance.get_experiment_results_for_metric_group(project_key, environment_key, experiment_key, metric_group_key, iteration_id=iteration_id)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiment_results_for_metric_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
experiment_key	str	The experiment key
metric_group_key	str	The metric group key
iteration_id	str	The iteration ID	[optional]

Return type

MetricGroupResultsRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experiment results response for metric group	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_experimentation_settings

RandomizationSettingsRep get_experimentation_settings(project_key)

Get experimentation settings

Get current experimentation settings for the given project

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.method_not_allowed_error_rep import MethodNotAllowedErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.randomization_settings_rep import RandomizationSettingsRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key

    # example passing only required values which don't have defaults set
    try:
        # Get experimentation settings
        api_response = api_instance.get_experimentation_settings(project_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experimentation_settings: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key

Return type

RandomizationSettingsRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experimentation settings response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_experiments

ExperimentCollectionRep get_experiments(project_key, environment_key)

Get experiments

Get details about all experiments in an environment. ### Filtering experiments LaunchDarkly supports the filter query param for filtering, with the following fields: - flagKey filters for only experiments that use the flag with the given key. - metricKey filters for only experiments that use the metric with the given key. - status filters for only experiments with an iteration with the given status. An iteration can have the status not_started, running or stopped. For example, filter=flagKey:my-flag,status:running,metricKey:page-load-ms filters for experiments for the given flag key and the given metric key which have a currently running iteration. ### Expanding the experiments response LaunchDarkly supports four fields for expanding the "Get experiments" response. By default, these fields are not included in the response. To expand the response, append the expand query parameter and add a comma-separated list with any of the following fields: - previousIterations includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - draftIteration includes the iteration which has not been started yet, if any. - secondaryMetrics includes secondary metrics. By default only the primary metric is included in the response. - treatments includes all treatment and parameter details. By default treatment data is not included in the response. For example, expand=draftIteration,treatments includes the draftIteration and treatments fields in the response. If fields that you request with the expand query parameter are empty, they are not included in the response.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.method_not_allowed_error_rep import MethodNotAllowedErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.experiment_collection_rep import ExperimentCollectionRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    limit = 1 # int | The maximum number of experiments to return. Defaults to 20. (optional)
    offset = 1 # int | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
    filter = "filter_example" # str | A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
    expand = "expand_example" # str | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
    lifecycle_state = "lifecycleState_example" # str | A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get experiments
        api_response = api_instance.get_experiments(project_key, environment_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiments: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get experiments
        api_response = api_instance.get_experiments(project_key, environment_key, limit=limit, offset=offset, filter=filter, expand=expand, lifecycle_state=lifecycle_state)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_experiments: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
limit	int	The maximum number of experiments to return. Defaults to 20.	[optional]
offset	int	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
filter	str	A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above.	[optional]
expand	str	A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.	[optional]
lifecycle_state	str	A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments.	[optional]

Return type

ExperimentCollectionRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experiment collection response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_legacy_experiment_results

ExperimentResults get_legacy_experiment_results(project_key, feature_flag_key, environment_key, metric_key)

Get legacy experiment results (deprecated)

Get detailed experiment result data for legacy experiments.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.experiment_results import ExperimentResults
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key
    environment_key = "environmentKey_example" # str | The environment key
    metric_key = "metricKey_example" # str | The metric key
    _from = 1 # int | A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
    to = 1 # int | A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get legacy experiment results (deprecated)
        api_response = api_instance.get_legacy_experiment_results(project_key, feature_flag_key, environment_key, metric_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_legacy_experiment_results: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get legacy experiment results (deprecated)
        api_response = api_instance.get_legacy_experiment_results(project_key, feature_flag_key, environment_key, metric_key, _from=_from, to=to)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->get_legacy_experiment_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_key	str	The feature flag key
environment_key	str	The environment key
metric_key	str	The metric key
_from	int	A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds.	[optional]
to	int	A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds.	[optional]

Return type

ExperimentResults

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experiment results response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_experiment

Experiment patch_experiment(project_key, environment_key, experiment_key, experiment_patch_input)

Patch experiment

Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch. ### Instructions Semantic patch requests support the following kind instructions for updating experiments. #### updateName Updates the experiment name. ##### Parameters - value: The new name. Here's an example: json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Example updated experiment name\" }] } #### updateDescription Updates the experiment description. ##### Parameters - value: The new description. Here's an example: json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Example updated description\" }] } #### startIteration Starts a new iteration for this experiment. You must create a new iteration before calling this instruction. An iteration may not be started until it meets the following criteria: * Its associated flag is toggled on and is not archived * Its randomizationUnit is set * At least one of its treatments has a non-zero allocationPercent ##### Parameters - changeJustification: The reason for starting a new iteration. Required when you call startIteration on an already running experiment, otherwise optional. Here's an example: json { \"instructions\": [{ \"kind\": \"startIteration\", \"changeJustification\": \"It's time to start a new iteration\" }] } #### stopIteration Stops the current iteration for this experiment. ##### Parameters - winningTreatmentId: The ID of the winning treatment. Treatment IDs are returned as part of the Get experiment response. They are the _id of each element in the treatments array. - winningReason: The reason for the winner Here's an example: json { \"instructions\": [{ \"kind\": \"stopIteration\", \"winningTreatmentId\": \"3a548ec2-72ac-4e59-8518-5c24f5609ccf\", \"winningReason\": \"Example reason to stop the iteration\" }] } #### archiveExperiment Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments. Here's an example: json { \"instructions\": [{ \"kind\": \"archiveExperiment\" }] } #### restoreExperiment Restores an archived experiment. After restoring an experiment, you can start new iterations for it again. Here's an example: json { \"instructions\": [{ \"kind\": \"restoreExperiment\" }] }

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.experiment import Experiment
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.experiment_patch_input import ExperimentPatchInput
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    experiment_key = "experimentKey_example" # str | The experiment key
    experiment_patch_input = ExperimentPatchInput(
        comment="Optional comment",
        instructions=Instructions([
            Instruction(
                key=None,
            ),
        ]),
    ) # ExperimentPatchInput | 

    # example passing only required values which don't have defaults set
    try:
        # Patch experiment
        api_response = api_instance.patch_experiment(project_key, environment_key, experiment_key, experiment_patch_input)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->patch_experiment: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
experiment_key	str	The experiment key
experiment_patch_input	ExperimentPatchInput

Return type

Experiment

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experiment response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
409	Conflict	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_experimentation_settings

RandomizationSettingsRep put_experimentation_settings(project_key, randomization_settings_put)

Update experimentation settings

Update experimentation settings for the given project

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import experiments_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.method_not_allowed_error_rep import MethodNotAllowedErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.randomization_settings_put import RandomizationSettingsPut
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.randomization_settings_rep import RandomizationSettingsRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experiments_api.ExperimentsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    randomization_settings_put = RandomizationSettingsPut(
        randomization_units=[
            RandomizationUnitInput(
                randomization_unit="user",
                default=True,
                standard_randomization_unit="guest",
            ),
        ],
    ) # RandomizationSettingsPut | 

    # example passing only required values which don't have defaults set
    try:
        # Update experimentation settings
        api_response = api_instance.put_experimentation_settings(project_key, randomization_settings_put)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ExperimentsApi->put_experimentation_settings: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
randomization_settings_put	RandomizationSettingsPut

Return type

RandomizationSettingsRep

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Experimentation settings response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ExperimentsApi.md

Latest commit

History

ExperimentsApi.md

File metadata and controls

launchdarkly_api.ExperimentsApi

create_experiment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_iteration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_experiment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_experiment_results

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_experiment_results_for_metric_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_experimentation_settings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_experiments

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_legacy_experiment_results

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_experiment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_experimentation_settings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details