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

List experiment metric groups

GET https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groupshttps://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groupshttps://api.datadoghq.eu/api/v2/experiments/{experiment_id}/metric-groupshttps://api.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groupshttps://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/metric-groupshttps://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groupshttps://api.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groupshttps://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/metric-groupshttps://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 to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

experiment_id [required]

string

The UUID of the experiment.

Response

OK

Response containing the metric groups for an experiment.

Expand All

Field

Type

Description

data [required]

[object]

Metric groups associated with the experiment.

attributes

object

Name, purpose, and selected metrics of an experiment metric group.

is_decision

boolean

Whether this group contains the experiment decision metrics.

metrics

[object]

Metrics selected for this experiment metric group.

is_primary [required]

boolean

Whether this is the experiment primary metric.

metric_id [required]

string

Identifier of the metric in the group.

metric_name [required]

string

Display name of the metric in the group.

migration_metadata

Metadata associated with migration of this resource.

name

string

Display name of the experiment metric group.

id [required]

uuid

Identifier of the experiment metric group.

type [required]

enum

Experiment metric groups resource type. Allowed enum values: experiment-metric-groups

default: experiment-metric-groups

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

Malformed experiment ID.

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

Missing or invalid authentication.

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

The caller lacks the experiments read permission.

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

No experiment with this ID exists for the organization.

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

                  # Path parameters
export experiment_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 GET "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" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}"