For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/experiments/update-experiment-metric-group.md. A documentation index is available at /llms.txt.
Language
Datadog site
CAUTIONThis product is not supported for your selected Datadog site. (US1-FED).
CAUTIONThis product is not supported for your selected Datadog site. (US2-FED).

Update experiment metric group

PATCHhttps://api.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}https://api.us2.ddog-gov.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 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)

Field
Type
Description
data [required]
object

JSON:API resource containing the experiment metric group identity and fields.

Response

OK

Response containing the saved experiment metric group and result refresh information.

Field
Type
Description
data [required]
object

Experiment metric group resource with its identifier and metric selection.

meta
object

Refresh requirements and warnings returned by an experiment update.

Code Example

Update experiment metric group returns "OK" response
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF
# Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
export metric_group_id="550e8400-e29b-41d4-a716-446655440000"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/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": {
    "type": "experiment-metric-groups",
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}
EOF