/launchdarkly-experiments | Type: Application | PCID required: Yes
Tools
launchdarkly_experiments_create_experiment
Create experiment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
analysisConfig | object | No | — | Analysis Config |
dataSource | string | No | — | The source of metric data in order to analyze results. Defaults to “launchdarkly” when not provided. |
description | string | No | — | The experiment description |
holdoutId | string | No | — | The ID of the holdout |
iteration | object | Yes | — | The iteration value |
key | string | Yes | — | The experiment key |
maintainerId | string | No | — | The ID of the member who maintains this experiment |
methodology | string | No | — | The results analysis approach. |
name | string | Yes | — | The experiment name |
tags | string[] | No | — | Tags for the experiment |
type | string | No | — | The type of experiment. |
launchdarkly_experiments_create_metric_group
Create metric group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
description | string | No | — | Description of the metric group |
key | string | No | — | A unique key to reference the metric group |
kind | string | Yes | — | The type of the metric group |
maintainerId | string | Yes | — | The ID of the member who maintains this metric group |
metrics | object[] | Yes | — | An ordered list of the metrics in this metric group |
name | string | Yes | — | A human-friendly name for the metric group |
tags | string[] | Yes | — | Tags for the metric group |
launchdarkly_experiments_delete_metric
Delete metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
metricKey | string | Yes | — | The metric key |
launchdarkly_experiments_delete_metric_group
Delete metric group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
metricGroupKey | string | Yes | — | The metric group key |
launchdarkly_experiments_get_all_holdouts
Get all holdouts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
limit | integer | No | — | The number of holdouts to return in the response. Defaults to 20 |
offset | integer | No | — | 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. |
launchdarkly_experiments_get_any_env
Get experiments any environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
limit | integer | No | — | The maximum number of experiments to return. Defaults to 20. |
offset | integer | No | — | 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. |
filter | string | No | — | A comma-separated list of filters. Each filter is of the form field:value. Supported fields are explained above. |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. |
lifecycleState | string | No | — | A comma-separated list of experiment archived states. Supports archived, active, or both. Defaults to active experiments. |
launchdarkly_experiments_get_experiment
Get experiment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
experimentKey | string | Yes | — | The experiment key |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. |
launchdarkly_experiments_get_experimentation_settings
Get experimentation settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
launchdarkly_experiments_get_experiments
Get experiments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
limit | integer | No | — | The maximum number of experiments to return. Defaults to 20. |
offset | integer | No | — | 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. |
filter | string | No | — | A comma-separated list of filters. Each filter is of the form field:value. Supported fields are explained above. |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. |
lifecycleState | string | No | — | A comma-separated list of experiment archived states. Supports archived, active, or both. Defaults to active experiments. |
launchdarkly_experiments_get_holdout
Get holdout Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
holdoutKey | string | Yes | — | The holdout experiment key |
expand | string | No | — | 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. |
launchdarkly_experiments_get_holdout_by_id
Get Holdout by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
holdoutId | string | Yes | — | The holdout experiment ID |
launchdarkly_experiments_get_metric
Get metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
metricKey | string | Yes | — | The metric key |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. Supported fields are experiments, experimentCount, metricGroups, metricGroupCount, eventSources, guardedRollouts, guardedRolloutCount, lastUsedInExperiment, and lastUsedInGuardedRollout. |
versionId | string | No | — | The specific version ID of the metric |
launchdarkly_experiments_get_metric_group
Get metric group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
metricGroupKey | string | Yes | — | The metric group key |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. |
launchdarkly_experiments_get_metric_groups
List metric groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
filter | string | No | — | Accepts filter by experimentStatus, query, kind, hasConnections, maintainerIds, and maintainerTeamKey. Example: filter=experimentStatus equals 'running' and query equals 'test'. |
sort | string | No | — | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. |
expand | string | No | — | This parameter is reserved for future use and is not currently supported on this endpoint. |
limit | integer | No | — | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items. |
launchdarkly_experiments_get_metrics
List metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. |
limit | integer | No | — | The number of metrics to return in the response. Defaults to 20. Maximum limit is 50. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items. |
sort | string | No | — | A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by createdAt or name. |
filter | string | No | — | A comma-separated list of filters. This endpoint accepts filtering by query, tags, eventKind, isNumeric, unitAggregationType, hasConnections, maintainerIds, maintainerTeamKey, view, dataSourceKeys, metricUsedIn, eventKeys, and versionIds. To learn more about the filter syntax, read the ‘Filtering metrics’ section above. |
launchdarkly_experiments_patch_experiment
Patch experiment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
experimentKey | string | Yes | — | The experiment key |
comment | string | No | — | Optional comment describing the update |
instructions | object[] | Yes | — | The instructions value |
launchdarkly_experiments_patch_holdout
Patch holdout Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
holdoutKey | string | Yes | — | The holdout key |
comment | string | No | — | Optional comment describing the update |
instructions | object[] | Yes | — | The instructions value |
launchdarkly_experiments_patch_metric
Update metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
metricKey | string | Yes | — | The metric key |
body | object[] | Yes | — | Request body |
launchdarkly_experiments_patch_metric_group
Patch metric group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
metricGroupKey | string | Yes | — | The metric group key |
body | object[] | Yes | — | Request body |
launchdarkly_experiments_post_holdout
Create holdout Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
attributes | string[] | No | — | The attributes that the holdout iteration’s results can be sliced by |
description | string | No | — | Description of the holdout |
holdoutamount | string | No | — | Audience allocation for the holdout |
key | string | No | — | A key that identifies the holdout |
maintainerId | string | No | — | Maintainer id |
metrics | object[] | No | — | Details on the metrics for this experiment |
name | string | No | — | A human-friendly name for the holdout |
prerequisiteflagkey | string | No | — | The key of the flag that the holdout is dependent on |
primarymetrickey | string | No | — | The key of the primary metric for this holdout |
randomizationunit | string | No | — | The chosen randomization unit for the holdout base experiment |
launchdarkly_experiments_post_metric
Create metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
analysisType | string | No | — | The method for analyzing metric events |
dataSource | object | No | — | Data Source |
description | string | No | — | Description of the metric |
eventDefault | object | No | — | Event Default |
eventKey | string | No | — | The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only. |
filters | object | No | — | The filters value |
isNumeric | boolean | No | — | Whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>). Required for custom and trace metrics only. |
key | string | Yes | — | A unique key to reference the metric |
kind | string | Yes | — | The kind of event your metric will track |
maintainerId | string | No | — | The ID of the member who maintains this metric |
name | string | No | — | A human-friendly name for the metric |
percentileValue | integer | No | — | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. |
randomizationUnits | string[] | No | — | An array of randomization units allowed for this metric |
selector | string | No | — | One or more CSS selectors. Required for click metrics only. |
successCriteria | string | No | — | Success criteria. Required for custom and trace numeric metrics, optional for custom and trace conversion metrics. |
tags | string[] | No | — | Tags for the metric |
traceQuery | string | No | — | The trace query to use for the metric. Required for trace metrics. |
traceValueLocation | string | No | — | The location in the trace to use for numeric values. Required for numeric trace metrics. |
unit | string | No | — | The unit of measure. Applicable for numeric custom and trace metrics only. |
unitAggregationType | string | No | — | The method by which multiple unit event values are aggregated |
urls | object[] | No | — | One or more target URLs. Required for click and pageview metrics only. |
windowEndOffset | integer | No | — | Not yet implemented - The end of the measurement window, in milliseconds relative to the unit’s first exposure to a flag variation |
windowStartOffset | integer | No | — | Not yet implemented - The start of the measurement window, in milliseconds relative to the unit’s first exposure to a flag variation |
launchdarkly_experiments_put_experimentation_settings
Update experimentation settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
randomizationUnits | object[] | Yes | — | An array of randomization units allowed for this project. |

