Get metric group

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Get information for a single metric group from the specific project.

Expanding the metric group response

LaunchDarkly supports two fields for expanding the “Get metric group” response. By default, these fields are not included in the response.

To expand the response, append the expand query parameter and add a comma-separated list with either or both of the following fields:

• experiments includes all experiments from the specific project that use the metric group
• experimentCount includes the number of experiments from the specific project that use the metric group

For example, expand=experiments includes the experiments field in the response.

GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}

Get metric group

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} \
  --header 'Authorization: <api-key>'

200

{
  "_id": "bc3e5be1-02d2-40c7-9926-26d0aacd7aab",
  "key": "metric-group-key-123abc",
  "name": "My metric group",
  "kind": "funnel",
  "_links": {
    "parent": {
      "href": "/api/v2/projects/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
      "type": "application/json"
    }
  },
  "tags": [
    "ops"
  ],
  "_creationDate": "1628192791148",
  "_lastModified": "1628192791148",
  "maintainer": {
    "member": {
      "_links": {
        "self": {
          "href": "/api/v2/members/569f183514f4432160000007",
          "type": "application/json"
        }
      },
      "_id": "569f183514f4432160000007",
      "role": "admin",
      "email": "[e-mail]",
      "firstName": "Ariel",
      "lastName": "Flores"
    },
    "team": {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team",
      "_links": {}
    }
  },
  "metrics": [
    {
      "key": "metric-key-123abc",
      "name": "Example metric",
      "kind": "custom",
      "_links": {
        "self": {
          "href": "/api/v2/metrics/my-project/my-metric",
          "type": "application/json"
        }
      },
      "_versionId": "version-id-123abc",
      "isNumeric": true,
      "unitAggregationType": "sum",
      "eventKey": "event-key-123abc",
      "nameInGroup": "Step 1",
      "randomizationUnits": [
        "user"
      ]
    }
  ],
  "_version": 1,
  "description": "Description of the metric group",
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "experiments": [
    {
      "key": "experiment-key-123abc",
      "name": "Example experiment",
      "environmentId": "1234a56b7c89d012345e678f",
      "environmentKey": "production",
      "creationDate": "1654104600000",
      "_links": {
        "parent": {
          "href": "/api/v2/projects/my-project/environments/my-environment",
          "type": "application/json"
        },
        "self": {
          "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
          "type": "application/json"
        }
      },
      "archivedDate": "1654104600000"
    }
  ],
  "experimentCount": 0,
  "activeExperimentCount": 0,
  "activeGuardedRolloutCount": 0
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

metricGroupKey · string<string> · required

The metric group key

Query Parameters

expand · string<string>

A comma-separated list of properties that can reveal additional information in the response.

Response

200

application/json

Metric group response

_id · string · required

The ID of this metric group

Example:

"bc3e5be1-02d2-40c7-9926-26d0aacd7aab"

key · string · required

A unique key to reference the metric group

Example:

"metric-group-key-123abc"

name · string · required

A human-friendly name for the metric group

Example:

"My metric group"

kind · enum<string> · required

The type of the metric group

Available options: funnel, standard

Example:

"funnel"

_links · object · required

The location and content type of related resources

Show child attributes

Example:

{
  "parent": {
    "href": "/api/v2/projects/my-project",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
    "type": "application/json"
  }
}

tags · string[] · required

Tags for the metric group

Example:

["ops"]

_creationDate · integer<int64> · required

Timestamp of when the metric group was created

Example:

"1628192791148"

_lastModified · integer<int64> · required

Timestamp of when the metric group was last modified

Example:

"1628192791148"

maintainer · object · required

The maintainer of this metric

Show child attributes

metrics · object[] · required

An ordered list of the metrics in this metric group

Show child attributes

_version · integer · required

The version of this metric group

Example:

1

description · string

Description of the metric group

Example:

"Description of the metric group"

_access · object

Details on the allowed and denied actions for this metric group

Show child attributes

experiments · object[]

Experiments that use this metric group. Only included if specified in the expand query parameter in a getMetricGroup request.

Show child attributes

experimentCount · integer

The number of experiments using this metric group

Example:

0

activeExperimentCount · integer

The number of active experiments using this metric group

Example:

0

activeGuardedRolloutCount · integer

The number of active guarded rollouts using this metric group

Example:

0