Create experiment metric group from collection

POST https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}

Overview

Copy a metric collection into a new non-decision metric group. The group is a request-time snapshot: later changes to the collection do not affect the experiment. Metric order is preserved. The operation is not idempotent, and incompatible or empty collections are rejected without creating a group. 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

Response

• 201
• 400
• 401
• 403
• 404
• 409
• 429

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

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export experiment_id="550e8400-e29b-41d4-a716-446655440000"
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 POST "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/${experiment_id}/metric-groups/from-collection/${metric_collection_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"