Experiments

Update experiment metric group

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.

patch/api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}

Request

Path parameters

experiment_idstring uuid required

The UUID of the experiment.

Example:550e8400-e29b-41d4-a716-446655440000
metric_group_idstring uuid required

The UUID of the metric group.

Example:550e8400-e29b-41d4-a716-446655440000

Request body

Example request

{
  "data": {
    "attributes": {
      "metrics": [
        {
          "metric_id": "550e8400-e29b-41d4-a716-446655440021"
        }
      ],
      "name": "Reliability"
    },
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "type": "experiment-metric-groups"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "metrics": [
        {
          "metric_id": "550e8400-e29b-41d4-a716-446655440000",
          "metric_name": "metric name"
        }
      ]
    },
    "id": "550e8400-e29b-41d4-a716-446655440022",
    "type": "experiment-metric-groups"
  },
  "meta": {
    "warnings": [
      {
        "code": "code",
        "detail": "detail"
      }
    ]
  }
}

Changes

Changes to this operation have not been checked yet.