Package com.launchdarkly.api.api

Class ExperimentsBetaApi

  • public class ExperimentsBetaApi
extends java.lang.Object

    • Constructor Detail

      • ExperimentsBetaApi

        public ExperimentsBetaApi()

      • ExperimentsBetaApi

        public ExperimentsBetaApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • createExperimentCall

        public okhttp3.Call createExperimentCall​(java.lang.String projectKey,
                                         java.lang.String environmentKey,
                                         ExperimentPost experimentPost,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for createExperiment
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentPost - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createExperiment

        public Experiment createExperiment​(java.lang.String projectKey,
                                   java.lang.String environmentKey,
                                   ExperimentPost experimentPost)
                            throws ApiException
        Create experiment Create an experiment. To run this experiment, you'll need to [create an iteration](/tag/Experiments-(beta)#operation/createIteration) and then [update the experiment](/tag/Experiments-(beta)#operation/patchExperiment) with the `startIteration` instruction. To learn more, read [Creating experiments](https://docs.launchdarkly.com/home/experimentation/create).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentPost - (required)
        Returns:
        Experiment
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createExperimentWithHttpInfo

        public ApiResponse<Experiment> createExperimentWithHttpInfo​(java.lang.String projectKey,
                                                            java.lang.String environmentKey,
                                                            ExperimentPost experimentPost)
                                                     throws ApiException
        Create experiment Create an experiment. To run this experiment, you'll need to [create an iteration](/tag/Experiments-(beta)#operation/createIteration) and then [update the experiment](/tag/Experiments-(beta)#operation/patchExperiment) with the `startIteration` instruction. To learn more, read [Creating experiments](https://docs.launchdarkly.com/home/experimentation/create).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentPost - (required)
        Returns:
        ApiResponse<Experiment>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createExperimentAsync

        public okhttp3.Call createExperimentAsync​(java.lang.String projectKey,
                                          java.lang.String environmentKey,
                                          ExperimentPost experimentPost,
                                          ApiCallback<Experiment> _callback)
                                   throws ApiException
        Create experiment (asynchronously) Create an experiment. To run this experiment, you'll need to [create an iteration](/tag/Experiments-(beta)#operation/createIteration) and then [update the experiment](/tag/Experiments-(beta)#operation/patchExperiment) with the `startIteration` instruction. To learn more, read [Creating experiments](https://docs.launchdarkly.com/home/experimentation/create).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentPost - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • createIterationCall

        public okhttp3.Call createIterationCall​(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        java.lang.String experimentKey,
                                        IterationInput iterationInput,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for createIteration
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        iterationInput - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createIteration

        public IterationRep createIteration​(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.lang.String experimentKey,
                                    IterationInput iterationInput)
                             throws ApiException
        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](/tag/Experiments-(beta)#operation/patchExperiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://docs.launchdarkly.com/home/experimentation/feature#start-experiment-iterations).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        iterationInput - (required)
        Returns:
        IterationRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createIterationWithHttpInfo

        public ApiResponse<IterationRep> createIterationWithHttpInfo​(java.lang.String projectKey,
                                                             java.lang.String environmentKey,
                                                             java.lang.String experimentKey,
                                                             IterationInput iterationInput)
                                                      throws ApiException
        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](/tag/Experiments-(beta)#operation/patchExperiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://docs.launchdarkly.com/home/experimentation/feature#start-experiment-iterations).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        iterationInput - (required)
        Returns:
        ApiResponse<IterationRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createIterationAsync

        public okhttp3.Call createIterationAsync​(java.lang.String projectKey,
                                         java.lang.String environmentKey,
                                         java.lang.String experimentKey,
                                         IterationInput iterationInput,
                                         ApiCallback<IterationRep> _callback)
                                  throws ApiException
        Create iteration (asynchronously) 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](/tag/Experiments-(beta)#operation/patchExperiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://docs.launchdarkly.com/home/experimentation/feature#start-experiment-iterations).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        iterationInput - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getExperimentCall

        public okhttp3.Call getExperimentCall​(java.lang.String projectKey,
                                      java.lang.String environmentKey,
                                      java.lang.String experimentKey,
                                      java.lang.String expand,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getExperiment
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExperiment

        public Experiment getExperiment​(java.lang.String projectKey,
                                java.lang.String environmentKey,
                                java.lang.String experimentKey,
                                java.lang.String expand)
                         throws ApiException
        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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        Returns:
        Experiment
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentWithHttpInfo

        public ApiResponse<Experiment> getExperimentWithHttpInfo​(java.lang.String projectKey,
                                                         java.lang.String environmentKey,
                                                         java.lang.String experimentKey,
                                                         java.lang.String expand)
                                                  throws ApiException
        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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        Returns:
        ApiResponse<Experiment>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentAsync

        public okhttp3.Call getExperimentAsync​(java.lang.String projectKey,
                                       java.lang.String environmentKey,
                                       java.lang.String experimentKey,
                                       java.lang.String expand,
                                       ApiCallback<Experiment> _callback)
                                throws ApiException
        Get experiment (asynchronously) 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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getExperimentResultsCall

        public okhttp3.Call getExperimentResultsCall​(java.lang.String projectKey,
                                             java.lang.String environmentKey,
                                             java.lang.String experimentKey,
                                             java.lang.String metricKey,
                                             java.lang.String iterationId,
                                             java.lang.String expand,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getExperimentResults
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricKey - The metric key (required)
        iterationId - The iteration ID (optional)
        expand - A comma-separated list of fields to expand in the response. Supported fields are explained above. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExperimentResults

        public ExperimentBayesianResultsRep getExperimentResults​(java.lang.String projectKey,
                                                         java.lang.String environmentKey,
                                                         java.lang.String experimentKey,
                                                         java.lang.String metricKey,
                                                         java.lang.String iterationId,
                                                         java.lang.String expand)
                                                  throws ApiException
        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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricKey - The metric key (required)
        iterationId - The iteration ID (optional)
        expand - A comma-separated list of fields to expand in the response. Supported fields are explained above. (optional)
        Returns:
        ExperimentBayesianResultsRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentResultsWithHttpInfo

        public ApiResponse<ExperimentBayesianResultsRep> getExperimentResultsWithHttpInfo​(java.lang.String projectKey,
                                                                                  java.lang.String environmentKey,
                                                                                  java.lang.String experimentKey,
                                                                                  java.lang.String metricKey,
                                                                                  java.lang.String iterationId,
                                                                                  java.lang.String expand)
                                                                           throws ApiException
        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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricKey - The metric key (required)
        iterationId - The iteration ID (optional)
        expand - A comma-separated list of fields to expand in the response. Supported fields are explained above. (optional)
        Returns:
        ApiResponse<ExperimentBayesianResultsRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentResultsAsync

        public okhttp3.Call getExperimentResultsAsync​(java.lang.String projectKey,
                                              java.lang.String environmentKey,
                                              java.lang.String experimentKey,
                                              java.lang.String metricKey,
                                              java.lang.String iterationId,
                                              java.lang.String expand,
                                              ApiCallback<ExperimentBayesianResultsRep> _callback)
                                       throws ApiException
        Get experiment results (asynchronously) 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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricKey - The metric key (required)
        iterationId - The iteration ID (optional)
        expand - A comma-separated list of fields to expand in the response. Supported fields are explained above. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getExperimentResultsForMetricGroupCall

        public okhttp3.Call getExperimentResultsForMetricGroupCall​(java.lang.String projectKey,
                                                           java.lang.String environmentKey,
                                                           java.lang.String experimentKey,
                                                           java.lang.String metricGroupKey,
                                                           java.lang.String iterationId,
                                                           ApiCallback _callback)
                                                    throws ApiException
        Build call for getExperimentResultsForMetricGroup
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricGroupKey - The metric group key (required)
        iterationId - The iteration ID (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExperimentResultsForMetricGroup

        public MetricGroupResultsRep getExperimentResultsForMetricGroup​(java.lang.String projectKey,
                                                                java.lang.String environmentKey,
                                                                java.lang.String experimentKey,
                                                                java.lang.String metricGroupKey,
                                                                java.lang.String iterationId)
                                                         throws ApiException
        Get experiment results for metric group Get results from an experiment for a particular metric group.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricGroupKey - The metric group key (required)
        iterationId - The iteration ID (optional)
        Returns:
        MetricGroupResultsRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentResultsForMetricGroupWithHttpInfo

        public ApiResponse<MetricGroupResultsRep> getExperimentResultsForMetricGroupWithHttpInfo​(java.lang.String projectKey,
                                                                                         java.lang.String environmentKey,
                                                                                         java.lang.String experimentKey,
                                                                                         java.lang.String metricGroupKey,
                                                                                         java.lang.String iterationId)
                                                                                  throws ApiException
        Get experiment results for metric group Get results from an experiment for a particular metric group.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricGroupKey - The metric group key (required)
        iterationId - The iteration ID (optional)
        Returns:
        ApiResponse<MetricGroupResultsRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentResultsForMetricGroupAsync

        public okhttp3.Call getExperimentResultsForMetricGroupAsync​(java.lang.String projectKey,
                                                            java.lang.String environmentKey,
                                                            java.lang.String experimentKey,
                                                            java.lang.String metricGroupKey,
                                                            java.lang.String iterationId,
                                                            ApiCallback<MetricGroupResultsRep> _callback)
                                                     throws ApiException
        Get experiment results for metric group (asynchronously) Get results from an experiment for a particular metric group.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricGroupKey - The metric group key (required)
        iterationId - The iteration ID (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getExperimentationSettingsCall

        public okhttp3.Call getExperimentationSettingsCall​(java.lang.String projectKey,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for getExperimentationSettings
        Parameters:
        projectKey - The project key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExperimentationSettings

        public RandomizationSettingsRep getExperimentationSettings​(java.lang.String projectKey)
                                                    throws ApiException
        Get experimentation settings Get current experimentation settings for the given project
        Parameters:
        projectKey - The project key (required)
        Returns:
        RandomizationSettingsRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentationSettingsWithHttpInfo

        public ApiResponse<RandomizationSettingsRep> getExperimentationSettingsWithHttpInfo​(java.lang.String projectKey)
                                                                             throws ApiException
        Get experimentation settings Get current experimentation settings for the given project
        Parameters:
        projectKey - The project key (required)
        Returns:
        ApiResponse<RandomizationSettingsRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentationSettingsAsync

        public okhttp3.Call getExperimentationSettingsAsync​(java.lang.String projectKey,
                                                    ApiCallback<RandomizationSettingsRep> _callback)
                                             throws ApiException
        Get experimentation settings (asynchronously) Get current experimentation settings for the given project
        Parameters:
        projectKey - The project key (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getExperimentsCall

        public okhttp3.Call getExperimentsCall​(java.lang.String projectKey,
                                       java.lang.String environmentKey,
                                       java.lang.Long limit,
                                       java.lang.Long offset,
                                       java.lang.String filter,
                                       java.lang.String expand,
                                       java.lang.String lifecycleState,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getExperiments
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The maximum number of experiments to return. Defaults to 20. (optional)
        offset - 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 - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        lifecycleState - A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExperiments

        public ExperimentCollectionRep getExperiments​(java.lang.String projectKey,
                                              java.lang.String environmentKey,
                                              java.lang.Long limit,
                                              java.lang.Long offset,
                                              java.lang.String filter,
                                              java.lang.String expand,
                                              java.lang.String lifecycleState)
                                       throws ApiException
        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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The maximum number of experiments to return. Defaults to 20. (optional)
        offset - 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 - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        lifecycleState - A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. (optional)
        Returns:
        ExperimentCollectionRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentsWithHttpInfo

        public ApiResponse<ExperimentCollectionRep> getExperimentsWithHttpInfo​(java.lang.String projectKey,
                                                                       java.lang.String environmentKey,
                                                                       java.lang.Long limit,
                                                                       java.lang.Long offset,
                                                                       java.lang.String filter,
                                                                       java.lang.String expand,
                                                                       java.lang.String lifecycleState)
                                                                throws ApiException
        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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The maximum number of experiments to return. Defaults to 20. (optional)
        offset - 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 - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        lifecycleState - A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. (optional)
        Returns:
        ApiResponse<ExperimentCollectionRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExperimentsAsync

        public okhttp3.Call getExperimentsAsync​(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        java.lang.Long limit,
                                        java.lang.Long offset,
                                        java.lang.String filter,
                                        java.lang.String expand,
                                        java.lang.String lifecycleState,
                                        ApiCallback<ExperimentCollectionRep> _callback)
                                 throws ApiException
        Get experiments (asynchronously) 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.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The maximum number of experiments to return. Defaults to 20. (optional)
        offset - 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 - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        lifecycleState - A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getLegacyExperimentResultsCall

        @Deprecated
public okhttp3.Call getLegacyExperimentResultsCall​(java.lang.String projectKey,
                                                   java.lang.String featureFlagKey,
                                                   java.lang.String environmentKey,
                                                   java.lang.String metricKey,
                                                   java.lang.Long from,
                                                   java.lang.Long to,
                                                   ApiCallback _callback)
                                            throws ApiException
        Deprecated.
        Build call for getLegacyExperimentResults
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric key (required)
        from - A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        to - A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getLegacyExperimentResults

        @Deprecated
public ExperimentResults getLegacyExperimentResults​(java.lang.String projectKey,
                                                    java.lang.String featureFlagKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String metricKey,
                                                    java.lang.Long from,
                                                    java.lang.Long to)
                                             throws ApiException
        Deprecated.
        Get legacy experiment results (deprecated) Get detailed experiment result data for legacy experiments.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric key (required)
        from - A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        to - A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        Returns:
        ExperimentResults
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLegacyExperimentResultsWithHttpInfo

        @Deprecated
public ApiResponse<ExperimentResults> getLegacyExperimentResultsWithHttpInfo​(java.lang.String projectKey,
                                                                             java.lang.String featureFlagKey,
                                                                             java.lang.String environmentKey,
                                                                             java.lang.String metricKey,
                                                                             java.lang.Long from,
                                                                             java.lang.Long to)
                                                                      throws ApiException
        Deprecated.
        Get legacy experiment results (deprecated) Get detailed experiment result data for legacy experiments.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric key (required)
        from - A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        to - A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        Returns:
        ApiResponse<ExperimentResults>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLegacyExperimentResultsAsync

        @Deprecated
public okhttp3.Call getLegacyExperimentResultsAsync​(java.lang.String projectKey,
                                                    java.lang.String featureFlagKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String metricKey,
                                                    java.lang.Long from,
                                                    java.lang.Long to,
                                                    ApiCallback<ExperimentResults> _callback)
                                             throws ApiException
        Deprecated.
        Get legacy experiment results (deprecated) (asynchronously) Get detailed experiment result data for legacy experiments.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric key (required)
        from - A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        to - A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • patchExperimentCall

        public okhttp3.Call patchExperimentCall​(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        java.lang.String experimentKey,
                                        ExperimentPatchInput experimentPatchInput,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for patchExperiment
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        experimentPatchInput - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchExperiment

        public Experiment patchExperiment​(java.lang.String projectKey,
                                  java.lang.String environmentKey,
                                  java.lang.String experimentKey,
                                  ExperimentPatchInput experimentPatchInput)
                           throws ApiException
        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](/reference#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](/tag/Experiments-(beta)#operation/createIteration) 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](/tag/Experiments-(beta)#operation/getExperiment) 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\" }] } ```
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        experimentPatchInput - (required)
        Returns:
        Experiment
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchExperimentWithHttpInfo

        public ApiResponse<Experiment> patchExperimentWithHttpInfo​(java.lang.String projectKey,
                                                           java.lang.String environmentKey,
                                                           java.lang.String experimentKey,
                                                           ExperimentPatchInput experimentPatchInput)
                                                    throws ApiException
        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](/reference#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](/tag/Experiments-(beta)#operation/createIteration) 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](/tag/Experiments-(beta)#operation/getExperiment) 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\" }] } ```
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        experimentPatchInput - (required)
        Returns:
        ApiResponse<Experiment>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchExperimentAsync

        public okhttp3.Call patchExperimentAsync​(java.lang.String projectKey,
                                         java.lang.String environmentKey,
                                         java.lang.String experimentKey,
                                         ExperimentPatchInput experimentPatchInput,
                                         ApiCallback<Experiment> _callback)
                                  throws ApiException
        Patch experiment (asynchronously) 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](/reference#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](/tag/Experiments-(beta)#operation/createIteration) 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](/tag/Experiments-(beta)#operation/getExperiment) 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\" }] } ```
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        experimentPatchInput - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • putExperimentationSettingsCall

        public okhttp3.Call putExperimentationSettingsCall​(java.lang.String projectKey,
                                                   RandomizationSettingsPut randomizationSettingsPut,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for putExperimentationSettings
        Parameters:
        projectKey - The project key (required)
        randomizationSettingsPut - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • putExperimentationSettings

        public RandomizationSettingsRep putExperimentationSettings​(java.lang.String projectKey,
                                                           RandomizationSettingsPut randomizationSettingsPut)
                                                    throws ApiException
        Update experimentation settings Update experimentation settings for the given project
        Parameters:
        projectKey - The project key (required)
        randomizationSettingsPut - (required)
        Returns:
        RandomizationSettingsRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • putExperimentationSettingsWithHttpInfo

        public ApiResponse<RandomizationSettingsRep> putExperimentationSettingsWithHttpInfo​(java.lang.String projectKey,
                                                                                    RandomizationSettingsPut randomizationSettingsPut)
                                                                             throws ApiException
        Update experimentation settings Update experimentation settings for the given project
        Parameters:
        projectKey - The project key (required)
        randomizationSettingsPut - (required)
        Returns:
        ApiResponse<RandomizationSettingsRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • putExperimentationSettingsAsync

        public okhttp3.Call putExperimentationSettingsAsync​(java.lang.String projectKey,
                                                    RandomizationSettingsPut randomizationSettingsPut,
                                                    ApiCallback<RandomizationSettingsRep> _callback)
                                             throws ApiException
        Update experimentation settings (asynchronously) Update experimentation settings for the given project
        Parameters:
        projectKey - The project key (required)
        randomizationSettingsPut - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object