launchdarkly_api.HoldoutsBetaApi

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

Method	HTTP request	Description
get_all_holdouts	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts	Get all holdouts
get_holdout	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}	Get holdout
get_holdout_by_id	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId}	Get Holdout by Id
patch_holdout	PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}	Patch holdout
post_holdout	POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts	Create holdout

get_all_holdouts

HoldoutsCollectionRep get_all_holdouts(project_key, environment_key, limit=limit, offset=offset)

Get all holdouts

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.holdouts_collection_rep import HoldoutsCollectionRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

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

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.HoldoutsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    environment_key = 'environment_key_example' # str | The environment key
    limit = 56 # int | The number of holdouts to return in the response. Defaults to 20 (optional)
    offset = 56 # int | Where to start in the list. Use this with pagination. For example, an `offset` of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

    try:
        # Get all holdouts
        api_response = api_instance.get_all_holdouts(project_key, environment_key, limit=limit, offset=offset)
        print("The response of HoldoutsBetaApi->get_all_holdouts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HoldoutsBetaApi->get_all_holdouts: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
limit	int	The number of holdouts to return in the response. Defaults to 20	[optional]
offset	int	Where to start in the list. Use this with pagination. For example, an `offset` of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]

Return type

HoldoutsCollectionRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	All Holdouts response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
429	Rate limited	-

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

get_holdout

HoldoutDetailRep get_holdout(project_key, environment_key, holdout_key, expand=expand)

Get holdout

Get details about a holdout.

Expanding the holdout response

LaunchDarkly supports the following fields for expanding the "Get holdout" 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:

draftIteration includes the iteration which has not been started yet, if any, for this holdout.
previousIterations includes all iterations prior to the current iteration, for this holdout. By default only the current iteration is included in the response.
rel-draftIteration includes the iteration which has not been started yet, if any, for the experiments related to this holdout.
rel-metrics includes metrics for experiments related to this holdout.
rel-previousIterations includes all iterations prior to the current iteration, for the experiments related to this holdout.
rel-secondaryMetrics includes secondary metrics for experiments related to this holdout.
rel-treatments includes all treatment and parameter details for experiments related to this holdout.
secondaryMetrics includes secondary metrics for this holdout. By default only the primary metric is included in the response.
treatments includes all treatment and parameter details for this holdout. By default treatment data is not included in the response.

For example, expand=draftIteration,rel-draftIteration includes the draftIteration and rel-draftIteration fields in the response. If fields that you request with the expand query parameter are empty, they are not included in the response.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.holdout_detail_rep import HoldoutDetailRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

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

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.HoldoutsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    environment_key = 'environment_key_example' # str | The environment key
    holdout_key = 'holdout_key_example' # str | The holdout experiment key
    expand = 'expand_example' # str | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. Holdout experiment expansion fields have no prefix. Related experiment expansion fields have `rel-` as a prefix. (optional)

    try:
        # Get holdout
        api_response = api_instance.get_holdout(project_key, environment_key, holdout_key, expand=expand)
        print("The response of HoldoutsBetaApi->get_holdout:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HoldoutsBetaApi->get_holdout: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
holdout_key	str	The holdout experiment key
expand	str	A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. Holdout experiment expansion fields have no prefix. Related experiment expansion fields have `rel-` as a prefix.	[optional]

Return type

HoldoutDetailRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

get_holdout_by_id

HoldoutRep get_holdout_by_id(project_key, environment_key, holdout_id)

Get Holdout by Id

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.holdout_rep import HoldoutRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

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

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.HoldoutsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    environment_key = 'environment_key_example' # str | The environment key
    holdout_id = 'holdout_id_example' # str | The holdout experiment ID

    try:
        # Get Holdout by Id
        api_response = api_instance.get_holdout_by_id(project_key, environment_key, holdout_id)
        print("The response of HoldoutsBetaApi->get_holdout_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HoldoutsBetaApi->get_holdout_by_id: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
holdout_id	str	The holdout experiment ID

Return type

HoldoutRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

patch_holdout

HoldoutRep patch_holdout(project_key, environment_key, holdout_key, holdout_patch_input)

Patch holdout

Updates an existing holdout, and returns the updated holdout. Updating holdouts uses the semantic patch format.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instructions for updating holdouts.

Click to expand instructions for updating holdouts

endHoldout

Ends a holdout.

Parameters

None.

Here's an example:

{
  "comment": "Optional comment describing why the holdout is ending",
  "instructions": [{
    "kind": "endHoldout"
  }]
}

removeExperiment

Removes an experiment from a holdout.

Parameters

value: The key of the experiment to remove

Here's an example:

{
  "comment": "Optional comment describing the change",
  "instructions": [{
    "kind": "removeExperiment",
    "value": "experiment-key"
  }]
}

updateDescription

Updates the description of the holdout.

Parameters

value: The new description.

Here's an example:

{
  "comment": "Optional comment describing the update",
  "instructions": [{
    "kind": "updateDescription",
    "value": "Updated holdout description"
  }]
}

updateName

Updates the name of the holdout.

Parameters

value: The new name.

Here's an example:

{
  "comment": "Optional comment describing the update",
  "instructions": [{
    "kind": "updateName",
    "value": "Updated holdout name"
  }]
}

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.holdout_patch_input import HoldoutPatchInput
from launchdarkly_api.models.holdout_rep import HoldoutRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

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

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.HoldoutsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    environment_key = 'environment_key_example' # str | The environment key
    holdout_key = 'holdout_key_example' # str | The holdout key
    holdout_patch_input = {"comment":"Optional comment describing the update","instructions":[{"kind":"updateName","value":"Updated holdout name"}]} # HoldoutPatchInput | 

    try:
        # Patch holdout
        api_response = api_instance.patch_holdout(project_key, environment_key, holdout_key, holdout_patch_input)
        print("The response of HoldoutsBetaApi->patch_holdout:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HoldoutsBetaApi->patch_holdout: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
holdout_key	str	The holdout key
holdout_patch_input	HoldoutPatchInput

Return type

HoldoutRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

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

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

post_holdout

HoldoutRep post_holdout(project_key, environment_key, holdout_post_request)

Create holdout

Create a new holdout in the specified project.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.holdout_post_request import HoldoutPostRequest
from launchdarkly_api.models.holdout_rep import HoldoutRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

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

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.HoldoutsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    environment_key = 'environment_key_example' # str | The environment key
    holdout_post_request = launchdarkly_api.HoldoutPostRequest() # HoldoutPostRequest | 

    try:
        # Create holdout
        api_response = api_instance.post_holdout(project_key, environment_key, holdout_post_request)
        print("The response of HoldoutsBetaApi->post_holdout:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HoldoutsBetaApi->post_holdout: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
holdout_post_request	HoldoutPostRequest

Return type

HoldoutRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Holdout response	-
400	Invalid request	-

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

FilesExpand file tree

HoldoutsBetaApi.md

Latest commit

History

HoldoutsBetaApi.md

File metadata and controls

launchdarkly_api.HoldoutsBetaApi

get_all_holdouts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_holdout

Expanding the holdout response

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_holdout_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_holdout

Instructions

endHoldout

Parameters

removeExperiment

Parameters

updateDescription

Parameters

updateName

Parameters

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_holdout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details