You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 3, 2026. It is now read-only.
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 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'`
215
+
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'`
216
216
217
217
### Example
218
218
@@ -236,7 +236,7 @@ $apiInstance = new LaunchDarklyApi\Api\MetricsBetaApi(
236
236
$project_key = 'project_key_example'; // string | The project key
237
237
$filter = 'filter_example'; // string | Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`.
238
238
$sort = 'sort_example'; // 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.
239
-
$expand = 'expand_example'; // string | A comma-separated list of properties that can reveal additional information in the response.
239
+
$expand = 'expand_example'; // string | This parameter is reserved for future use and is not currently supported on this endpoint.
240
240
$limit = 56; // int | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
241
241
$offset = 56; // int | 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.
242
242
@@ -255,7 +255,7 @@ try {
255
255
|**project_key**|**string**| The project key ||
256
256
|**filter**|**string**| Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. |[optional]|
257
257
|**sort**|**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. |[optional]|
258
-
|**expand**|**string**|A comma-separated list of properties that can reveal additional information in the response. |[optional]|
258
+
|**expand**|**string**|This parameter is reserved for future use and is not currently supported on this endpoint. |[optional]|
259
259
|**limit**|**int**| The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. |[optional]|
260
260
|**offset**|**int**| 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. |[optional]|
**default_track_events** | **bool** | Enables tracking detailed information for new flags by default |
17
18
**require_comments** | **bool** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment |
18
19
**confirm_changes** | **bool** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes |
Copy file name to clipboardExpand all lines: lib/Api/MetricsBetaApi.php
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1205,7 +1205,7 @@ public function getMetricGroupRequest($project_key, $metric_group_key, $expand =
1205
1205
* @param string $project_key The project key (required)
1206
1206
* @param string|null $filter Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
1207
1207
* @param string|null $sort 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. (optional)
1208
-
* @param string|null $expand A comma-separated list of properties that can reveal additional information in the response. (optional)
1208
+
* @param string|null $expand This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
1209
1209
* @param int|null $limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional)
1210
1210
* @param int|null $offset 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. (optional)
1211
1211
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getMetricGroups'] to see the possible values for this operation
@@ -1228,7 +1228,7 @@ public function getMetricGroups($project_key, $filter = null, $sort = null, $exp
1228
1228
* @param string $project_key The project key (required)
1229
1229
* @param string|null $filter Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
1230
1230
* @param string|null $sort 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. (optional)
1231
-
* @param string|null $expand A comma-separated list of properties that can reveal additional information in the response. (optional)
1231
+
* @param string|null $expand This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
1232
1232
* @param int|null $limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional)
1233
1233
* @param int|null $offset 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. (optional)
1234
1234
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getMetricGroups'] to see the possible values for this operation
@@ -1402,7 +1402,7 @@ public function getMetricGroupsWithHttpInfo($project_key, $filter = null, $sort
1402
1402
* @param string $project_key The project key (required)
1403
1403
* @param string|null $filter Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
1404
1404
* @param string|null $sort 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. (optional)
1405
-
* @param string|null $expand A comma-separated list of properties that can reveal additional information in the response. (optional)
1405
+
* @param string|null $expand This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
1406
1406
* @param int|null $limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional)
1407
1407
* @param int|null $offset 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. (optional)
1408
1408
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getMetricGroups'] to see the possible values for this operation
@@ -1428,7 +1428,7 @@ function ($response) {
1428
1428
* @param string $project_key The project key (required)
1429
1429
* @param string|null $filter Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
1430
1430
* @param string|null $sort 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. (optional)
1431
-
* @param string|null $expand A comma-separated list of properties that can reveal additional information in the response. (optional)
1431
+
* @param string|null $expand This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
1432
1432
* @param int|null $limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional)
1433
1433
* @param int|null $offset 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. (optional)
1434
1434
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getMetricGroups'] to see the possible values for this operation
@@ -1483,7 +1483,7 @@ function ($exception) {
1483
1483
* @param string $project_key The project key (required)
1484
1484
* @param string|null $filter Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
1485
1485
* @param string|null $sort 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. (optional)
1486
-
* @param string|null $expand A comma-separated list of properties that can reveal additional information in the response. (optional)
1486
+
* @param string|null $expand This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
1487
1487
* @param int|null $limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional)
1488
1488
* @param int|null $offset 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. (optional)
1489
1489
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getMetricGroups'] to see the possible values for this operation
0 commit comments