This product is not supported for your selected Datadog site. ().

Conclude experiment

POST https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/concludehttps://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/concludehttps://api.datadoghq.eu/api/v2/experiments/{experiment_id}/concludehttps://api.ddog-gov.com/api/v2/experiments/{experiment_id}/concludehttps://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/concludehttps://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/concludehttps://api.datadoghq.com/api/v2/experiments/{experiment_id}/concludehttps://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/concludehttps://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/conclude

Overview

Conclude an experiment on a winning variant. The experiment moves to DECISION_MADE status, the outcome is recorded in its conclusion, and for a flag-backed experiment the winning variant is rolled out to 100% of the linked feature flag allocation. decision_variant_key must match a variant in the experiment. Only an experiment that is currently running or ready for a decision can be concluded. Concluding is not reversible and is not idempotent: concluding an already-concluded experiment returns 409. This endpoint requires the product_analytics_experiments_write permission.

OAuth apps require the product_analytics_experiments_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

experiment_id [required]

string

The UUID of the experiment.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Experiment conclusion resource with the experiment identifier and decision.

attributes [required]

object

Decision to record when concluding the experiment.

decision_variant_key [required]

string

Key of the winning variant. Must match a variant on the experiment and must not be blank.

id

string

Identifier of the experiment to conclude.

type [required]

enum

Conclude experiment request resource type. Allowed enum values: conclude-experiment-request

default: conclude-experiment-request

{
  "data": {
    "attributes": {
      "decision_variant_key": "treatment"
    },
    "id": "string",
    "type": "conclude-experiment-request"
  }
}

Response

The experiment was concluded and the winning variant was rolled out to its linked feature flag allocation.

Malformed experiment ID, malformed request body, or a missing decision_variant_key.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Missing or invalid authentication (dd-api-key + dd-application-key headers, or a valid user session).

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Authenticated caller lacks the product_analytics_experiments_write permission, lacks permission to edit this experiment, or lacks contribute permission on the feature flag owning its allocation.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

No experiment with this ID exists for the organization.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

The experiment is not running or ready for a decision, its linked feature flag environment requires an approval for the rollout this would perform, or that flag has a pending suggestion for its allocations.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/experiments/${experiment_id}/conclude" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "decision_variant_key": "treatment" }, "type": "conclude-experiment-request" } } EOF
"""
Conclude experiment returns "The experiment was concluded and the winning variant was rolled out to its linked feature
flag allocation." response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.experiments_api import ExperimentsApi
from datadog_api_client.v2.model.experiments_conclude_experiment_v2_request import (
    ExperimentsConcludeExperimentV2Request,
)
from datadog_api_client.v2.model.experiments_conclude_experiment_v2_request_data import (
    ExperimentsConcludeExperimentV2RequestData,
)
from datadog_api_client.v2.model.experiments_conclude_experiment_v2_request_data_attributes import (
    ExperimentsConcludeExperimentV2RequestDataAttributes,
)
from datadog_api_client.v2.model.experiments_conclude_experiment_v2_request_data_type import (
    ExperimentsConcludeExperimentV2RequestDataType,
)
from uuid import UUID

body = ExperimentsConcludeExperimentV2Request(
    data=ExperimentsConcludeExperimentV2RequestData(
        attributes=ExperimentsConcludeExperimentV2RequestDataAttributes(
            decision_variant_key="treatment",
        ),
        type=ExperimentsConcludeExperimentV2RequestDataType.CONCLUDE_EXPERIMENT_REQUEST,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = ExperimentsApi(api_client)
    api_instance.conclude_experiment(experiment_id=UUID("550e8400-e29b-41d4-a716-446655440000"), body=body)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
# Conclude experiment returns "The experiment was concluded and the winning variant was rolled out to its linked feature
# flag allocation." response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::ExperimentsAPI.new

body = DatadogAPIClient::V2::ExperimentsConcludeExperimentV2Request.new({
  data: DatadogAPIClient::V2::ExperimentsConcludeExperimentV2RequestData.new({
    attributes: DatadogAPIClient::V2::ExperimentsConcludeExperimentV2RequestDataAttributes.new({
      decision_variant_key: "treatment",
    }),
    type: DatadogAPIClient::V2::ExperimentsConcludeExperimentV2RequestDataType::CONCLUDE_EXPERIMENT_REQUEST,
  }),
})
api_instance.conclude_experiment("550e8400-e29b-41d4-a716-446655440000", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"
// Conclude experiment returns "The experiment was concluded and the winning variant was rolled out to its linked feature
// flag allocation." response

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
	"github.com/google/uuid"
)

func main() {
	body := datadogV2.ExperimentsConcludeExperimentV2Request{
		Data: datadogV2.ExperimentsConcludeExperimentV2RequestData{
			Attributes: datadogV2.ExperimentsConcludeExperimentV2RequestDataAttributes{
				DecisionVariantKey: "treatment",
			},
			Type: datadogV2.EXPERIMENTSCONCLUDEEXPERIMENTV2REQUESTDATATYPE_CONCLUDE_EXPERIMENT_REQUEST,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewExperimentsApi(apiClient)
	r, err := api.ConcludeExperiment(ctx, uuid.MustParse("550e8400-e29b-41d4-a716-446655440000"), body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ExperimentsApi.ConcludeExperiment`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
// Conclude experiment returns "The experiment was concluded and the winning variant was rolled out
// to its linked feature
// flag allocation." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.model.ExperimentsConcludeExperimentV2Request;
import com.datadog.api.client.v2.model.ExperimentsConcludeExperimentV2RequestData;
import com.datadog.api.client.v2.model.ExperimentsConcludeExperimentV2RequestDataAttributes;
import com.datadog.api.client.v2.model.ExperimentsConcludeExperimentV2RequestDataType;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

    ExperimentsConcludeExperimentV2Request body =
        new ExperimentsConcludeExperimentV2Request()
            .data(
                new ExperimentsConcludeExperimentV2RequestData()
                    .attributes(
                        new ExperimentsConcludeExperimentV2RequestDataAttributes()
                            .decisionVariantKey("treatment"))
                    .type(
                        ExperimentsConcludeExperimentV2RequestDataType
                            .CONCLUDE_EXPERIMENT_REQUEST));

    try {
      apiInstance.concludeExperiment(UUID.fromString("550e8400-e29b-41d4-a716-446655440000"), body);
    } catch (ApiException e) {
      System.err.println("Exception when calling ExperimentsApi#concludeExperiment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
// Conclude experiment returns "The experiment was concluded and the winning
// variant was rolled out to its linked feature flag allocation." response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_experiments::ExperimentsAPI;
use datadog_api_client::datadogV2::model::ExperimentsConcludeExperimentV2Request;
use datadog_api_client::datadogV2::model::ExperimentsConcludeExperimentV2RequestData;
use datadog_api_client::datadogV2::model::ExperimentsConcludeExperimentV2RequestDataAttributes;
use datadog_api_client::datadogV2::model::ExperimentsConcludeExperimentV2RequestDataType;
use uuid::Uuid;

#[tokio::main]
async fn main() {
    let body = ExperimentsConcludeExperimentV2Request::new(
        ExperimentsConcludeExperimentV2RequestData::new(
            ExperimentsConcludeExperimentV2RequestDataAttributes::new("treatment".to_string()),
            ExperimentsConcludeExperimentV2RequestDataType::CONCLUDE_EXPERIMENT_REQUEST,
        ),
    );
    let configuration = datadog::Configuration::new();
    let api = ExperimentsAPI::with_config(configuration);
    let resp = api
        .conclude_experiment(
            Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000").expect("invalid UUID"),
            body,
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run