List metric groups

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

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "_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": {
        "key": "569fdeadbeef1644facecafe",
        "kind": "member",
        "_member": {
          "_links": {
            "self": {
              "href": "/api/v2/members/569f183514f4432160000007",
              "type": "application/json"
            }
          },
          "_id": "569f183514f4432160000007",
          "role": "admin",
          "email": "ariel@acme.com",
          "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",
          "analysisType": "mean",
          "eventKey": "event-key-123abc",
          "analysisUnit": "<string>",
          "nameInGroup": "Step 1",
          "randomizationUnits": [
            "user"
          ],
          "analysisUnits": [
            "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
    }
  ],
  "_links": {
    "parent": {
      "href": "/api/v2/projects/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/projects/my-project/metric-groups",
      "type": "application/json"
    }
  },
  "totalCount": 123
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "method_not_allowed",
  "message": "Method not allowed"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

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:

Field	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'

GET

api

projects

{projectKey}

metric-groups

List metric groups

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

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "_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": {
        "key": "569fdeadbeef1644facecafe",
        "kind": "member",
        "_member": {
          "_links": {
            "self": {
              "href": "/api/v2/members/569f183514f4432160000007",
              "type": "application/json"
            }
          },
          "_id": "569f183514f4432160000007",
          "role": "admin",
          "email": "ariel@acme.com",
          "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",
          "analysisType": "mean",
          "eventKey": "event-key-123abc",
          "analysisUnit": "<string>",
          "nameInGroup": "Step 1",
          "randomizationUnits": [
            "user"
          ],
          "analysisUnits": [
            "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
    }
  ],
  "_links": {
    "parent": {
      "href": "/api/v2/projects/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/projects/my-project/metric-groups",
      "type": "application/json"
    }
  },
  "totalCount": 123
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "method_not_allowed",
  "message": "Method not allowed"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Path Parameters

projectKey

string<string>

required

The project key

Query Parameters

filter

string<string>

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

sort

string<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.

expand

string<string>

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

limit

integer<int64>

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

offset

integer<int64>

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

items

object[]

required

An array of metric groups

Show child attributes

_links

object

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",
    "type": "application/json"
  }
}

totalCount

integer