--- title: Update experiment metric group description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Experiments --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Update experiment metric group{% #update-experiment-metric-group %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------------------------------ | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | uk1.datadoghq.com | PATCH https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id} | ### Overview Update a non-decision metric group. Omitted attributes are unchanged; a supplied metrics array is the complete ordered replacement. Decision groups remain managed through the experiment resource. This operation does not synchronously recompute results. This endpoint requires the `product_analytics_experiments_write` permission. OAuth apps require the `product_analytics_experiments_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#experiments) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | --------------------------------- | ------ | ----------------------------- | | experiment_id [*required*] | string | The UUID of the experiment. | | metric_group_id [*required*] | string | The UUID of the metric group. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | --------------------------- | -------- | --------------------------------------------------------------------------------------- | | | data [*required*] | object | JSON:API resource containing the experiment metric group identity and fields. | | data | attributes | object | Fields supplied to update the experiment metric group. | | attributes | metrics | [object] | Metrics included in this group. | | metrics | metric_id [*required*] | uuid | Identifier of the metric to include in the group. | | attributes | migration_metadata | | Metadata retained for resources imported from another system. | | attributes | name | string | Display name of the experiment metric group. | | data | id | uuid | ID of the experiment metric group. | | data | type [*required*] | enum | Experiment metric groups resource type. Allowed enum values: `experiment-metric-groups` | {% /tab %} {% tab title="Example" %} ```json { "data": { "type": "experiment-metric-groups", "id": "550e8400-e29b-41d4-a716-446655440022", "attributes": { "name": "ex-14bb9543f523edde updated" } } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing the saved experiment metric group and result refresh information. | Parent field | Field | Type | Description | | ------------ | ---------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Experiment metric group resource with its identifier and metric selection. | | data | attributes | object | Name, purpose, and selected metrics of an experiment metric group. | | attributes | is_decision | boolean | Whether this group contains the experiment decision metrics. | | attributes | metrics | [object] | Metrics selected for this experiment metric group. | | metrics | is_primary [*required*] | boolean | Whether this is the experiment primary metric. | | metrics | metric_id [*required*] | string | Identifier of the metric in the group. | | metrics | metric_name [*required*] | string | Display name of the metric in the group. | | attributes | migration_metadata | | Metadata associated with migration of this resource. | | attributes | name | string | Display name of the experiment metric group. | | data | id [*required*] | uuid | Identifier of the experiment metric group. | | data | type [*required*] | enum | Experiment metric groups resource type. Allowed enum values: `experiment-metric-groups` | | | meta | object | Refresh requirements and warnings returned by an experiment update. | | meta | needs_pipeline_refresh [*required*] | boolean | Whether this edit needs a full or non-full pipeline run. This operation does not start the run. A later false value does not clear a refresh required by an earlier edit. | | meta | refresh_endpoint | string | POST to this endpoint after finishing your edits. The full_refresh query parameter selects the required run type. Across multiple edits any full_refresh=true requirement takes priority. | | meta | warnings | [object] | Warnings returned after the experiment update. | | warnings | code [*required*] | string | Code that identifies the warning. | | warnings | detail [*required*] | string | Explanation of the warning and its effect on the update. | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "is_decision": false, "metrics": [ { "is_primary": false, "metric_id": "550e8400-e29b-41d4-a716-446655440000", "metric_name": "metric name" } ], "migration_metadata": "undefined", "name": "string" }, "id": "550e8400-e29b-41d4-a716-446655440022", "type": "experiment-metric-groups" }, "meta": { "needs_pipeline_refresh": false, "refresh_endpoint": "string", "warnings": [ { "code": "code", "detail": "detail" } ] } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="409" %} Conflict {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="415" %} Request body sent with a media type other than application/json or application/vnd.api+json. {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export experiment_id="550e8400-e29b-41d4-a716-446655440000" export metric_group_id="550e8400-e29b-41d4-a716-446655440000" \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X PATCH "https://api.datadoghq.com/api/v2/experiments/${experiment_id}/metric-groups/${metric_group_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "metrics": [ { "metric_id": "550e8400-e29b-41d4-a716-446655440021" } ], "name": "Reliability" }, "id": "550e8400-e29b-41d4-a716-446655440022", "type": "experiment-metric-groups" } } EOF ##### ```go // Update experiment metric group returns "OK" response package main import ( "context" "encoding/json" "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() { // there is a valid "experiment" in the system ExperimentDataID := uuid.MustParse(os.Getenv("EXPERIMENT_DATA_ID")) // there is a valid "experiment_metric_group" in the system ExperimentMetricGroupDataID := uuid.MustParse(os.Getenv("EXPERIMENT_METRIC_GROUP_DATA_ID")) body := datadogV2.ExperimentsPatchExperimentMetricGroupV2Request{ Data: datadogV2.ExperimentsPatchExperimentMetricGroupV2RequestData{ Type: datadogV2.EXPERIMENTSPATCHEXPERIMENTMETRICGROUPV2REQUESTDATATYPE_EXPERIMENT_METRIC_GROUPS, Id: datadog.PtrUUID(ExperimentMetricGroupDataID), Attributes: &datadogV2.ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes{ Name: datadog.PtrString("ex-14bb9543f523edde updated"), }, }, } 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) resp, r, err := api.UpdateExperimentMetricGroup(ctx, ExperimentDataID, ExperimentMetricGroupDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ExperimentsApi.UpdateExperimentMetricGroup`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ExperimentsApi.UpdateExperimentMetricGroup`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ##### ```java // Update experiment metric group returns "OK" 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.ExperimentsExperimentMetricGroupMutationV2; import com.datadog.api.client.v2.model.ExperimentsPatchExperimentMetricGroupV2Request; import com.datadog.api.client.v2.model.ExperimentsPatchExperimentMetricGroupV2RequestData; import com.datadog.api.client.v2.model.ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes; import com.datadog.api.client.v2.model.ExperimentsPatchExperimentMetricGroupV2RequestDataType; 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); // there is a valid "experiment" in the system UUID EXPERIMENT_DATA_ID = null; try { EXPERIMENT_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_DATA_ID")); } catch (IllegalArgumentException e) { System.err.println("Error parsing UUID: " + e.getMessage()); } // there is a valid "experiment_metric_group" in the system UUID EXPERIMENT_METRIC_GROUP_DATA_ID = null; try { EXPERIMENT_METRIC_GROUP_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_METRIC_GROUP_DATA_ID")); } catch (IllegalArgumentException e) { System.err.println("Error parsing UUID: " + e.getMessage()); } ExperimentsPatchExperimentMetricGroupV2Request body = new ExperimentsPatchExperimentMetricGroupV2Request() .data( new ExperimentsPatchExperimentMetricGroupV2RequestData() .type( ExperimentsPatchExperimentMetricGroupV2RequestDataType .EXPERIMENT_METRIC_GROUPS) .id(EXPERIMENT_METRIC_GROUP_DATA_ID) .attributes( new ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes() .name("ex-14bb9543f523edde updated"))); try { ExperimentsExperimentMetricGroupMutationV2 result = apiInstance.updateExperimentMetricGroup( EXPERIMENT_DATA_ID, EXPERIMENT_METRIC_GROUP_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ExperimentsApi#updateExperimentMetricGroup"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ##### ```python """ Update experiment metric group returns "OK" 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_patch_experiment_metric_group_v2_request import ( ExperimentsPatchExperimentMetricGroupV2Request, ) from datadog_api_client.v2.model.experiments_patch_experiment_metric_group_v2_request_data import ( ExperimentsPatchExperimentMetricGroupV2RequestData, ) from datadog_api_client.v2.model.experiments_patch_experiment_metric_group_v2_request_data_attributes import ( ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes, ) from datadog_api_client.v2.model.experiments_patch_experiment_metric_group_v2_request_data_type import ( ExperimentsPatchExperimentMetricGroupV2RequestDataType, ) # there is a valid "experiment" in the system EXPERIMENT_DATA_ID = environ["EXPERIMENT_DATA_ID"] # there is a valid "experiment_metric_group" in the system EXPERIMENT_METRIC_GROUP_DATA_ID = environ["EXPERIMENT_METRIC_GROUP_DATA_ID"] body = ExperimentsPatchExperimentMetricGroupV2Request( data=ExperimentsPatchExperimentMetricGroupV2RequestData( type=ExperimentsPatchExperimentMetricGroupV2RequestDataType.EXPERIMENT_METRIC_GROUPS, id=EXPERIMENT_METRIC_GROUP_DATA_ID, attributes=ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes( name="ex-14bb9543f523edde updated", ), ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = ExperimentsApi(api_client) response = api_instance.update_experiment_metric_group( experiment_id=EXPERIMENT_DATA_ID, metric_group_id=EXPERIMENT_METRIC_GROUP_DATA_ID, body=body ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ##### ```ruby # Update experiment metric group returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::ExperimentsAPI.new # there is a valid "experiment" in the system EXPERIMENT_DATA_ID = ENV["EXPERIMENT_DATA_ID"] # there is a valid "experiment_metric_group" in the system EXPERIMENT_METRIC_GROUP_DATA_ID = ENV["EXPERIMENT_METRIC_GROUP_DATA_ID"] body = DatadogAPIClient::V2::ExperimentsPatchExperimentMetricGroupV2Request.new({ data: DatadogAPIClient::V2::ExperimentsPatchExperimentMetricGroupV2RequestData.new({ type: DatadogAPIClient::V2::ExperimentsPatchExperimentMetricGroupV2RequestDataType::EXPERIMENT_METRIC_GROUPS, id: EXPERIMENT_METRIC_GROUP_DATA_ID, attributes: DatadogAPIClient::V2::ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes.new({ name: "ex-14bb9543f523edde updated", }), }), }) p api_instance.update_experiment_metric_group(EXPERIMENT_DATA_ID, EXPERIMENT_METRIC_GROUP_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ##### ```rust // Update experiment metric group returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_experiments::ExperimentsAPI; use datadog_api_client::datadogV2::model::ExperimentsPatchExperimentMetricGroupV2Request; use datadog_api_client::datadogV2::model::ExperimentsPatchExperimentMetricGroupV2RequestData; use datadog_api_client::datadogV2::model::ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes; use datadog_api_client::datadogV2::model::ExperimentsPatchExperimentMetricGroupV2RequestDataType; #[tokio::main] async fn main() { // there is a valid "experiment" in the system let experiment_data_id = uuid::Uuid::parse_str(&std::env::var("EXPERIMENT_DATA_ID").unwrap()).expect("Invalid UUID"); // there is a valid "experiment_metric_group" in the system let experiment_metric_group_data_id = uuid::Uuid::parse_str(&std::env::var("EXPERIMENT_METRIC_GROUP_DATA_ID").unwrap()) .expect("Invalid UUID"); let body = ExperimentsPatchExperimentMetricGroupV2Request::new( ExperimentsPatchExperimentMetricGroupV2RequestData::new( ExperimentsPatchExperimentMetricGroupV2RequestDataType::EXPERIMENT_METRIC_GROUPS, ) .attributes( ExperimentsPatchExperimentMetricGroupV2RequestDataAttributes::new() .name("ex-14bb9543f523edde updated".to_string()), ) .id(experiment_metric_group_data_id.clone()), ); let configuration = datadog::Configuration::new(); let api = ExperimentsAPI::with_config(configuration); let resp = api .update_experiment_metric_group( experiment_data_id.clone(), experiment_metric_group_data_id.clone(), body, ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run {% /tab %}