--- title: List experiment metric groups 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 %} # List experiment metric groups{% #list-experiment-metric-groups %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/metric-groups | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | ### Overview List every decision and non-decision metric group attached to an experiment. Metric references are returned in their stored order. An incomplete draft can have no decision group and returns only the groups that exist. This endpoint requires the `product_analytics_experiments_read` permission. OAuth apps require the `product_analytics_experiments_read` 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. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing the metric groups for an experiment. | Parent field | Field | Type | Description | | ------------ | ----------------------------- | -------- | --------------------------------------------------------------------------------------- | | | data [*required*] | [object] | Metric groups associated with the experiment. | | 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` | {% /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" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Malformed experiment ID. {% 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" %} Missing or invalid authentication. {% 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" %} The caller lacks the experiments read permission. {% 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" %} No experiment with this ID exists for the organization. {% 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 ##### \# Path parameters export experiment_id="550e8400-e29b-41d4-a716-446655440000" \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/experiments/${experiment_id}/metric-groups" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ##### ```python """ List experiment metric groups returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.experiments_api import ExperimentsApi # there is a valid "experiment" in the system EXPERIMENT_DATA_ID = environ["EXPERIMENT_DATA_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = ExperimentsApi(api_client) response = api_instance.list_experiment_metric_groups( experiment_id=EXPERIMENT_DATA_ID, ) 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 # List experiment metric groups 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"] p api_instance.list_experiment_metric_groups(EXPERIMENT_DATA_ID) ``` #### 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" ##### ```go // List experiment metric groups 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")) 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.ListExperimentMetricGroups(ctx, ExperimentDataID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ExperimentsApi.ListExperimentMetricGroups`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ExperimentsApi.ListExperimentMetricGroups`:\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 // List experiment metric groups 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.ExperimentsExperimentMetricGroupV2DTOArray; 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()); } try { ExperimentsExperimentMetricGroupV2DTOArray result = apiInstance.listExperimentMetricGroups(EXPERIMENT_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ExperimentsApi#listExperimentMetricGroups"); 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" ##### ```rust // List experiment metric groups returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_experiments::ExperimentsAPI; #[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"); let configuration = datadog::Configuration::new(); let api = ExperimentsAPI::with_config(configuration); let resp = api .list_experiment_metric_groups(experiment_data_id.clone()) .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 %}