List metric groups

Get a list of all metric groups for the specified project.

Expanding the metric groups response

This endpoint does not support response expansion.

Although the API accepts an expand query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use.

Filtering metric groups

The filter parameter supports the following operators: contains, equals, anyOf.

Supported fields and operators

You can only filter certain fields in metrics when using the filter parameter. Additionally, you can only filter some fields with certain operators.

When you search for metrics, the filter parameter supports the following fields and operators:

<div style="width:120px">Field</div>	Description	Supported operators
experimentStatus	The experiment's status. One of not_started, running, stopped, started.	equals
hasConnections	Whether the metric group has connections to experiments or guarded rollouts. One of true, false.	equals
kind	The metric group kind. One of funnel, standard.	equals
maintainerIds	The metric maintainer IDs.	anyOf
maintainerTeamKey	The metric maintainer team key.	equals
query	A "fuzzy" search across metric group key and name. Supply a string or list of strings to the operator.	equals

Sorting metric groups

LaunchDarkly supports the following fields for sorting:

name sorts by metric group name.
createdAt sorts by the creation date of the metric group.
connectionCount sorts by the number of connections to experiments the metric group has.

By default, the sort is in ascending order. Use - to sort in descending order. For example, ?sort=name sorts the response by metric group name in ascending order, and ?sort=-name sorts in descending order.

Sample query

filter=experimentStatus equals 'not_started' and query equals 'metric name'

projectKeystring string required

The project key

filterstring string

Accepts filter by experimentStatus, query, kind, hasConnections, maintainerIds, and maintainerTeamKey. Example: filter=experimentStatus equals 'running' and query equals 'test'.

sortstring string

A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.

expandstring string

This parameter is reserved for future use and is not currently supported on this endpoint.

limitinteger

The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.

offsetinteger

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items.

Response

Metric group collection response

_linksobject

The location and content type of related resources

totalCountinteger

Example response

{
  "items": [
    {
      "_id": "bc3e5be1-02d2-40c7-9926-26d0aacd7aab",
      "key": "metric-group-key-123abc",
      "name": "My metric group",
      "kind": "funnel",
      "description": "Description of the metric group",
      "_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"
        }
      },
      "_access": {
        "denied": [
          {
            "reason": {
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "actions": [
                "*"
              ],
              "effect": "allow"
            }
          }
        ],
        "allowed": [
          {
            "reason": {
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "actions": [
                "*"
              ],
              "effect": "allow"
            }
          }
        ]
      },
      "tags": [
        "ops"
      ],
      "maintainer": {
        "member": {
          "_links": {
            "self": {
              "href": "/api/v2/members/569f183514f4432160000007",
              "type": "application/json"
            }
          },
          "_id": "569f183514f4432160000007",
          "firstName": "Ariel",
          "lastName": "Flores",
          "role": "admin",
          "email": "ariel@acme.com"
        },
        "team": {
          "customRoleKeys": [
            "access-to-test-projects"
          ],
          "key": "team-key-123abc",
          "name": "QA Team"
        }
      },
      "metrics": [
        {
          "key": "metric-key-123abc",
          "_versionId": "version-id-123abc",
          "name": "Example metric",
          "kind": "custom",
          "isNumeric": true,
          "unitAggregationType": "sum",
          "eventKey": "event-key-123abc",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "nameInGroup": "Step 1",
          "randomizationUnits": [
            "user"
          ]
        }
      ],
      "_version": 1,
      "experiments": [
        {
          "key": "experiment-key-123abc",
          "name": "Example experiment",
          "environmentId": "1234a56b7c89d012345e678f",
          "environmentKey": "production",
          "_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"
            }
          }
        }
      ]
    }
  ],
  "_links": {
    "parent": {
      "href": "/api/v2/projects/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/projects/my-project/metric-groups",
      "type": "application/json"
    }
  }
}

v5