--- title: Create 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 %} # Create experiment metric group{% #create-experiment-metric-group %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/metric-groups | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups | ### Overview Create a non-decision metric group. The optional metrics array is ordered. Decision groups remain managed through decision_metrics on 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. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------- | | | data [*required*] | object | Metric group resource to create on the experiment. | | data | attributes [*required*] | object | Name and metric selection for the new experiment metric group. | | attributes | metrics | [object] | Metrics to include in the experiment metric group. | | metrics | metric_id [*required*] | uuid | Identifier of the metric to include in the group. | | attributes | migration_metadata | | Metadata associated with migration of this resource. | | attributes | name [*required*] | string | Display name of the experiment metric group. | | data | id | string | Optional JSON:API resource identifier field. | | 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", "attributes": { "name": "ex-14bb9543f523edde", "metrics": [ { "metric_id": "550e8400-e29b-41d4-a716-446655440002" } ] } } } ``` {% /tab %} ### Response {% tab title="201" %} Created {% 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" \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/experiments/${experiment_id}/metric-groups" \ -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": "Diagnostics" }, "type": "experiment-metric-groups" } } EOF {% /tab %}