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

Update metric collection

PATCH https://api.ap1.datadoghq.com/api/v2/experiments/metric-collections/{metric_collection_id}https://api.ap2.datadoghq.com/api/v2/experiments/metric-collections/{metric_collection_id}https://api.datadoghq.eu/api/v2/experiments/metric-collections/{metric_collection_id}https://api.ddog-gov.com/api/v2/experiments/metric-collections/{metric_collection_id}https://api.us2.ddog-gov.com/api/v2/experiments/metric-collections/{metric_collection_id}https://api.uk1.datadoghq.com/api/v2/experiments/metric-collections/{metric_collection_id}https://api.datadoghq.com/api/v2/experiments/metric-collections/{metric_collection_id}https://api.us3.datadoghq.com/api/v2/experiments/metric-collections/{metric_collection_id}https://api.us5.datadoghq.com/api/v2/experiments/metric-collections/{metric_collection_id}

Overview

Update metric collection. This endpoint requires the product_analytics_metrics_write permission.

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

Arguments

Path Parameters

Name

Type

Description

metric_collection_id [required]

string

The UUID of the metric collection.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

JSON:API resource containing the metric collection identity and fields.

attributes

object

Fields supplied to update the metric collection.

description

string

Text that explains the metric collection.

is_guardrail

boolean

Whether the collection is used for guardrail metrics.

metrics

[object]

Metrics included in this collection.

metric_id [required]

uuid

Identifier of the metric to include in the collection.

name

string

Display name of the metric collection.

id

string

ID of the metric collection.

type [required]

enum

Metric collections resource type. Allowed enum values: metric-collections

default: metric-collections

{
  "data": {
    "type": "metric-collections",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}

Response

OK

Response containing the metric collection.

Expand All

Field

Type

Description

data [required]

object

JSON:API resource containing the metric collection identity and fields.

attributes

object

Details of the metric collection.

created_at

date-time

Time when this resource was created.

description

string

Text that explains the metric collection.

is_guardrail

boolean

Whether the collection is used for guardrail metrics.

metric_count

int64

Number of metrics in this collection.

metrics

[object]

Metrics included in this collection.

metric_id

string

ID of the metric represented by this entry.

metric_name

string

Display name of the metric represented by this entry.

name

string

Display name of the metric collection.

updated_at

date-time

Time when this resource was last updated.

id [required]

uuid

ID of the metric collection.

type [required]

enum

Metric collections resource type. Allowed enum values: metric-collections

default: metric-collections

{
  "data": {
    "attributes": {
      "created_at": "2026-08-01T12:00:00Z",
      "description": "Metrics reviewed for every checkout experiment.",
      "is_guardrail": false,
      "metrics": [
        {
          "metric_id": "550e8400-e29b-41d4-a716-446655440020",
          "metric_name": "Checkout conversion"
        }
      ],
      "name": "Checkout metrics",
      "updated_at": "2026-08-02T09:30:00Z"
    },
    "id": "550e8400-e29b-41d4-a716-446655440040",
    "type": "metric-collections"
  }
}

Bad Request

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"
    }
  ]
}

Unauthorized

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"
    }
  ]
}

Forbidden

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"
    }
  ]
}

Not Found

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"
    }
  ]
}

Conflict

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"
    }
  ]
}

Request body sent with a media type other than application/json or application/vnd.api+json.

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 metric_collection_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 PATCH "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/metric-collections/${metric_collection_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "metrics": [] }, "type": "metric-collections" } } EOF
// Update metric collection 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_metric_collection" in the system
	ExperimentMetricCollectionDataID := uuid.MustParse(os.Getenv("EXPERIMENT_METRIC_COLLECTION_DATA_ID"))

	body := datadogV2.ExperimentsPatchMetricCollectionV2Request{
		Data: datadogV2.ExperimentsPatchMetricCollectionV2RequestData{
			Type: datadogV2.EXPERIMENTSPATCHMETRICCOLLECTIONV2REQUESTDATATYPE_METRIC_COLLECTIONS,
			Attributes: &datadogV2.ExperimentsPatchMetricCollectionV2RequestDataAttributes{
				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.UpdateMetricCollection(ctx, ExperimentMetricCollectionDataID, body)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ExperimentsApi.UpdateMetricCollection`:\n%s\n", responseContent)
}

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"
// Update metric collection 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.ExperimentsMetricCollectionV2DTO;
import com.datadog.api.client.v2.model.ExperimentsPatchMetricCollectionV2Request;
import com.datadog.api.client.v2.model.ExperimentsPatchMetricCollectionV2RequestData;
import com.datadog.api.client.v2.model.ExperimentsPatchMetricCollectionV2RequestDataAttributes;
import com.datadog.api.client.v2.model.ExperimentsPatchMetricCollectionV2RequestDataType;
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_metric_collection" in the system
    UUID EXPERIMENT_METRIC_COLLECTION_DATA_ID = null;
    try {
      EXPERIMENT_METRIC_COLLECTION_DATA_ID =
          UUID.fromString(System.getenv("EXPERIMENT_METRIC_COLLECTION_DATA_ID"));
    } catch (IllegalArgumentException e) {
      System.err.println("Error parsing UUID: " + e.getMessage());
    }

    ExperimentsPatchMetricCollectionV2Request body =
        new ExperimentsPatchMetricCollectionV2Request()
            .data(
                new ExperimentsPatchMetricCollectionV2RequestData()
                    .type(ExperimentsPatchMetricCollectionV2RequestDataType.METRIC_COLLECTIONS)
                    .attributes(
                        new ExperimentsPatchMetricCollectionV2RequestDataAttributes()
                            .name("ex-14bb9543f523edde updated")));

    try {
      ExperimentsMetricCollectionV2DTO result =
          apiInstance.updateMetricCollection(EXPERIMENT_METRIC_COLLECTION_DATA_ID, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ExperimentsApi#updateMetricCollection");
      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"
"""
Update metric collection 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_metric_collection_v2_request import (
    ExperimentsPatchMetricCollectionV2Request,
)
from datadog_api_client.v2.model.experiments_patch_metric_collection_v2_request_data import (
    ExperimentsPatchMetricCollectionV2RequestData,
)
from datadog_api_client.v2.model.experiments_patch_metric_collection_v2_request_data_attributes import (
    ExperimentsPatchMetricCollectionV2RequestDataAttributes,
)
from datadog_api_client.v2.model.experiments_patch_metric_collection_v2_request_data_type import (
    ExperimentsPatchMetricCollectionV2RequestDataType,
)

# there is a valid "experiment_metric_collection" in the system
EXPERIMENT_METRIC_COLLECTION_DATA_ID = environ["EXPERIMENT_METRIC_COLLECTION_DATA_ID"]

body = ExperimentsPatchMetricCollectionV2Request(
    data=ExperimentsPatchMetricCollectionV2RequestData(
        type=ExperimentsPatchMetricCollectionV2RequestDataType.METRIC_COLLECTIONS,
        attributes=ExperimentsPatchMetricCollectionV2RequestDataAttributes(
            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_metric_collection(
        metric_collection_id=EXPERIMENT_METRIC_COLLECTION_DATA_ID, body=body
    )

    print(response)

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"
# Update metric collection 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_metric_collection" in the system
EXPERIMENT_METRIC_COLLECTION_DATA_ID = ENV["EXPERIMENT_METRIC_COLLECTION_DATA_ID"]

body = DatadogAPIClient::V2::ExperimentsPatchMetricCollectionV2Request.new({
  data: DatadogAPIClient::V2::ExperimentsPatchMetricCollectionV2RequestData.new({
    type: DatadogAPIClient::V2::ExperimentsPatchMetricCollectionV2RequestDataType::METRIC_COLLECTIONS,
    attributes: DatadogAPIClient::V2::ExperimentsPatchMetricCollectionV2RequestDataAttributes.new({
      name: "ex-14bb9543f523edde updated",
    }),
  }),
})
p api_instance.update_metric_collection(EXPERIMENT_METRIC_COLLECTION_DATA_ID, 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"
// Update metric collection returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_experiments::ExperimentsAPI;
use datadog_api_client::datadogV2::model::ExperimentsPatchMetricCollectionV2Request;
use datadog_api_client::datadogV2::model::ExperimentsPatchMetricCollectionV2RequestData;
use datadog_api_client::datadogV2::model::ExperimentsPatchMetricCollectionV2RequestDataAttributes;
use datadog_api_client::datadogV2::model::ExperimentsPatchMetricCollectionV2RequestDataType;

#[tokio::main]
async fn main() {
    // there is a valid "experiment_metric_collection" in the system
    let experiment_metric_collection_data_id =
        uuid::Uuid::parse_str(&std::env::var("EXPERIMENT_METRIC_COLLECTION_DATA_ID").unwrap())
            .expect("Invalid UUID");
    let body = ExperimentsPatchMetricCollectionV2Request::new(
        ExperimentsPatchMetricCollectionV2RequestData::new(
            ExperimentsPatchMetricCollectionV2RequestDataType::METRIC_COLLECTIONS,
        )
        .attributes(
            ExperimentsPatchMetricCollectionV2RequestDataAttributes::new()
                .name("ex-14bb9543f523edde updated".to_string()),
        ),
    );
    let configuration = datadog::Configuration::new();
    let api = ExperimentsAPI::with_config(configuration);
    let resp = api
        .update_metric_collection(experiment_metric_collection_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 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