List metric groups

GET
/api/v2/projects/:projectKey/metric-groups

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

Expanding the metric groups response

LaunchDarkly supports one field for expanding the “Get metric groups” 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 the following field:

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

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

Filtering metric groups

The filter parameter supports the equals operator on the following fields: experimentStatus, query.

The experimentStatus field supports the following values: not_started, running, stopped, and started. The query field is a search query that is compared against the metric group name and key.

Sample query

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

Path parameters

projectKeystringRequired

The project key

Query parameters

filterstringOptional

Accepts filter by experimentStatus and query. Example: filter=experimentStatus equals 'running' and query equals 'test'.

expandstringOptional

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

limitlongOptional

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

offsetlongOptional

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

itemslist of objects

An array of metric groups

_linksmap from strings to objectsOptional

The location and content type of related resources

totalCountintegerOptional

Errors

Patch metric group
Built with