Package com.launchdarkly.api.api

Class ExperimentsBetaApi

  • public class ExperimentsBetaApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Experiment createExperiment​(java.lang.String projectKey, java.lang.String environmentKey, ExperimentPost experimentPost)
      Create experiment Create an experiment.
      okhttp3.Call createExperimentAsync​(java.lang.String projectKey, java.lang.String environmentKey, ExperimentPost experimentPost, ApiCallback<Experiment> _callback)
      Create experiment (asynchronously) Create an experiment.
      okhttp3.Call createExperimentCall​(java.lang.String projectKey, java.lang.String environmentKey, ExperimentPost experimentPost, ApiCallback _callback)
      Build call for createExperiment
      ApiResponse<Experiment> createExperimentWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, ExperimentPost experimentPost)
      Create experiment Create an experiment.
      IterationRep createIteration​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, IterationInput iterationInput)
      Create iteration Create an experiment iteration.
      okhttp3.Call createIterationAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, IterationInput iterationInput, ApiCallback<IterationRep> _callback)
      Create iteration (asynchronously) Create an experiment iteration.
      okhttp3.Call createIterationCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, IterationInput iterationInput, ApiCallback _callback)
      Build call for createIteration
      ApiResponse<IterationRep> createIterationWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, IterationInput iterationInput)
      Create iteration Create an experiment iteration.
      ApiClient getApiClient()  
      java.lang.String getCustomBaseUrl()  
      Experiment getExperiment​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey)
      Get experiment Get details about an experiment.
      okhttp3.Call getExperimentAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, ApiCallback<Experiment> _callback)
      Get experiment (asynchronously) Get details about an experiment.
      okhttp3.Call getExperimentCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, ApiCallback _callback)
      Build call for getExperiment
      ExperimentBayesianResultsRep getExperimentResults​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, java.lang.String metricKey)
      Get experiment results Get results from an experiment for a particular metric.
      okhttp3.Call getExperimentResultsAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, java.lang.String metricKey, ApiCallback<ExperimentBayesianResultsRep> _callback)
      Get experiment results (asynchronously) Get results from an experiment for a particular metric.
      okhttp3.Call getExperimentResultsCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, java.lang.String metricKey, ApiCallback _callback)
      Build call for getExperimentResults
      ApiResponse<ExperimentBayesianResultsRep> getExperimentResultsWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, java.lang.String metricKey)
      Get experiment results Get results from an experiment for a particular metric.
      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)
      Get experiments Get details about all experiments in an environment.
      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, ApiCallback<ExperimentCollectionRep> _callback)
      Get experiments (asynchronously) Get details about all experiments in an environment.
      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, ApiCallback _callback)
      Build call for getExperiments
      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)
      Get experiments Get details about all experiments in an environment.
      ApiResponse<Experiment> getExperimentWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey)
      Get experiment Get details about an experiment.
      int getHostIndex()  
      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)
      Get legacy experiment results (deprecated) Get detailed experiment result data for legacy experiments.
      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)
      Get legacy experiment results (deprecated) (asynchronously) Get detailed experiment result data for legacy experiments.
      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)
      Build call for getLegacyExperimentResults
      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)
      Get legacy experiment results (deprecated) Get detailed experiment result data for legacy experiments.
      Experiment patchExperiment​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, ExperimentPatchInput experimentPatchInput)
      Patch experiment Update an experiment.
      okhttp3.Call patchExperimentAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, ExperimentPatchInput experimentPatchInput, ApiCallback<Experiment> _callback)
      Patch experiment (asynchronously) Update an experiment.
      okhttp3.Call patchExperimentCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, ExperimentPatchInput experimentPatchInput, ApiCallback _callback)
      Build call for patchExperiment
      ApiResponse<Experiment> patchExperimentWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String experimentKey, ExperimentPatchInput experimentPatchInput)
      Patch experiment Update an experiment.
      void resetExperiment​(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String metricKey)
      Reset experiment results Reset all experiment results by deleting all existing data for an experiment.
      okhttp3.Call resetExperimentAsync​(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String metricKey, ApiCallback<java.lang.Void> _callback)
      Reset experiment results (asynchronously) Reset all experiment results by deleting all existing data for an experiment.
      okhttp3.Call resetExperimentCall​(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String metricKey, ApiCallback _callback)
      Build call for resetExperiment
      ApiResponse<java.lang.Void> resetExperimentWithHttpInfo​(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String metricKey)
      Reset experiment results Reset all experiment results by deleting all existing data for an experiment.
      void setApiClient​(ApiClient apiClient)  
      void setCustomBaseUrl​(java.lang.String customBaseUrl)  
      void setHostIndex​(int hostIndex)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • 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 learn more, read [Creating experiments](https://docs.launchdarkly.com/home/creating-experiments).
        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 learn more, read [Creating experiments](https://docs.launchdarkly.com/home/creating-experiments).
        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 learn more, read [Creating experiments](https://docs.launchdarkly.com/home/creating-experiments).
        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 discrete blocks of time. To learn more, read [Starting experiment iterations](https://docs.launchdarkly.com/home/creating-experiments#starting-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 discrete blocks of time. To learn more, read [Starting experiment iterations](https://docs.launchdarkly.com/home/creating-experiments#starting-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 discrete blocks of time. To learn more, read [Starting experiment iterations](https://docs.launchdarkly.com/home/creating-experiments#starting-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,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getExperiment
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        _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)
                         throws ApiException
        Get experiment Get details about an experiment.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        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)
                                                  throws ApiException
        Get experiment Get details about an experiment.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        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,
                                       ApiCallback<Experiment> _callback)
                                throws ApiException
        Get experiment (asynchronously) Get details about an experiment.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment 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

      • getExperimentResultsCall

        public okhttp3.Call getExperimentResultsCall​(java.lang.String projectKey,
                                             java.lang.String environmentKey,
                                             java.lang.String experimentKey,
                                             java.lang.String metricKey,
                                             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)
        _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)
                                                  throws ApiException
        Get experiment results Get results from an experiment for a particular metric.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricKey - The metric key (required)
        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)
                                                                           throws ApiException
        Get experiment results Get results from an experiment for a particular metric.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricKey - The metric key (required)
        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,
                                              ApiCallback<ExperimentBayesianResultsRep> _callback)
                                       throws ApiException
        Get experiment results (asynchronously) Get results from an experiment for a particular metric.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        experimentKey - The experiment key (required)
        metricKey - The metric 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,
                                       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)
        _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)
                                       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 \"List 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 will be included in the response. - `draftIteration` includes a draft of an 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 will not be included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields 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)
        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)
                                                                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 \"List 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 will be included in the response. - `draftIteration` includes a draft of an 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 will not be included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields 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)
        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,
                                        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 \"List 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 will be included in the response. - `draftIteration` includes a draft of an 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 will not be included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields 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)
        _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

        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
        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

        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
        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

        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
        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

        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
        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. #### updateDescription Updates the experiment description. ##### Parameters - `value`: The new description. #### startIteration Starts a new iteration for this experiment. #### stopIteration Stops the current iteration for this experiment.
        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. #### updateDescription Updates the experiment description. ##### Parameters - `value`: The new description. #### startIteration Starts a new iteration for this experiment. #### stopIteration Stops the current iteration for this experiment.
        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. #### updateDescription Updates the experiment description. ##### Parameters - `value`: The new description. #### startIteration Starts a new iteration for this experiment. #### stopIteration Stops the current iteration for this experiment.
        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

      • resetExperimentCall

        public okhttp3.Call resetExperimentCall​(java.lang.String projectKey,
                                        java.lang.String featureFlagKey,
                                        java.lang.String environmentKey,
                                        java.lang.String metricKey,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for resetExperiment
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric's key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • resetExperiment

        public void resetExperiment​(java.lang.String projectKey,
                            java.lang.String featureFlagKey,
                            java.lang.String environmentKey,
                            java.lang.String metricKey)
                     throws ApiException
        Reset experiment results Reset all experiment results by deleting all existing data for an experiment.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric's key (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • resetExperimentWithHttpInfo

        public ApiResponse<java.lang.Void> resetExperimentWithHttpInfo​(java.lang.String projectKey,
                                                               java.lang.String featureFlagKey,
                                                               java.lang.String environmentKey,
                                                               java.lang.String metricKey)
                                                        throws ApiException
        Reset experiment results Reset all experiment results by deleting all existing data for an experiment.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric's key (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • resetExperimentAsync

        public okhttp3.Call resetExperimentAsync​(java.lang.String projectKey,
                                         java.lang.String featureFlagKey,
                                         java.lang.String environmentKey,
                                         java.lang.String metricKey,
                                         ApiCallback<java.lang.Void> _callback)
                                  throws ApiException
        Reset experiment results (asynchronously) Reset all experiment results by deleting all existing data for an experiment.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        metricKey - The metric's 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