List metrics | LaunchDarkly

1 curl https://app.launchdarkly.com/api/v2/metrics/projectKey \ 2 -H "Authorization: <apiKey>"

1 { 2 "items": [ 3 { 4 "_id": "5902deadbeef667524a01290", 5 "_versionId": "version-id-123abc", 6 "key": "metric-key-123abc", 7 "name": "My metric", 8 "kind": "pageview", 9 "_links": { 10 "parent": { 11 "href": "/api/v2/metrics/my-project", 12 "type": "application/json" 13 }, 14 "self": { 15 "href": "/api/v2/metrics/my-project/my-metric", 16 "type": "application/json" 17 } 18 }, 19 "tags": [ 20 "tags" 21 ], 22 "_creationDate": 1000000, 23 "experimentCount": 0, 24 "metricGroupCount": 0, 25 "activeExperimentCount": 2, 26 "activeGuardedRolloutCount": 1, 27 "_version": 1, 28 "_attachedFlagCount": 0, 29 "_access": { 30 "denied": [ 31 { 32 "action": "action", 33 "reason": { 34 "effect": "allow" 35 } 36 } 37 ], 38 "allowed": [ 39 { 40 "action": "action", 41 "reason": { 42 "effect": "allow" 43 } 44 } 45 ] 46 }, 47 "lastModified": { 48 "date": "2021-08-05T19:46:31Z" 49 }, 50 "maintainerId": "569fdeadbeef1644facecafe", 51 "_maintainer": { 52 "_links": { 53 "self": { 54 "href": "/api/v2/members/569f183514f4432160000007", 55 "type": "application/json" 56 } 57 }, 58 "_id": "569f183514f4432160000007", 59 "role": "admin", 60 "email": "ariel@acme.com", 61 "firstName": "Ariel", 62 "lastName": "Flores" 63 }, 64 "description": "description", 65 "category": "Error monitoring", 66 "isNumeric": true, 67 "successCriteria": "HigherThanBaseline", 68 "unit": "unit", 69 "eventKey": "Order placed", 70 "randomizationUnits": [ 71 "user" 72 ], 73 "filters": { 74 "type": "group", 75 "op": "op", 76 "values": [ 77 "JP" 78 ], 79 "negate": false, 80 "attribute": "country", 81 "contextKind": "user" 82 }, 83 "unitAggregationType": "average", 84 "analysisType": "mean", 85 "percentileValue": 95, 86 "eventDefault": { 87 "value": 0 88 }, 89 "archived": true, 90 "archivedAt": 1000000, 91 "selector": "selector", 92 "urls": [ 93 { 94 "key": "value" 95 } 96 ] 97 } 98 ], 99 "_links": { 100 "self": { 101 "href": "/api/v2/metrics/my-project?limit=20", 102 "type": "application/json" 103 } 104 }, 105 "totalCount": 1 106 }

Get a list of all metrics for the specified project.

Filtering metrics

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
`eventKind`	The metric event kind. One of `custom`, `pageview`, `click`.	`equals`
`hasConnections`	Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`.	`equals`
`isNumeric`	Whether the metric is numeric. One of `true`, `false`.	`equals`
`maintainerIds`	A comma-separated list of metric maintainer IDs.	`anyOf`
`maintainerTeamKey`	The metric maintainer team key.	`equals`
`query`	A “fuzzy” search across metric key and name. Supply a string or list of strings to the operator.	`equals`
`tags`	The metric tags.	`contains`
`unitAggregationType`	The metric’s unit aggregation type. One of `sum`, `average`.	`equals`

For example, the filter ?filter=tags contains ["tag1", "tag2", "tag3"] matches metrics that have all three tags.

The documented values for filter query parameters are prior to URL encoding. For example, the [ in ?filter=tags contains ["tag1", "tag2", "tag3"] must be encoded to %5B.

Expanding the metric list response

LaunchDarkly supports expanding the “List metrics” response. By default, the expandable field is not included in the response.

To expand the response, append the expand query parameter and add the following supported field:

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

For example, expand=experimentCount includes the experimentCount field for each metric in the response.

Get a list of all metrics for the specified project. ### Filtering metrics 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 | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A "fuzzy" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric's unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains ["tag1", "tag2", "tag3"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains ["tag1", "tag2", "tag3"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the "List metrics" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response.

Path parameters

projectKeystringRequired

The project key

Query parameters

expandstringOptional

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

limitlongOptional

The number of metrics 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.

sortstringOptional

A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by createdAt or name.

filterstringOptional

A comma-separated list of filters. This endpoint accepts filtering by query, tags, ‘eventKind’, ‘isNumeric’, ‘unitAggregationType, hasConnections, maintainerIds, maintainerTeamKeyandview`. To learn more about the filter syntax, read the ‘Filtering metrics’ section above.

Response

Metrics collection response

itemslist of objects or null

An array of metrics

_linksmap from strings to objects or null

The location and content type of related resources

totalCountinteger or null

Errors

Get a list of all metrics for the specified project.

Filtering metrics

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
`eventKind`	The metric event kind. One of `custom`, `pageview`, `click`.	`equals`
`hasConnections`	Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`.	`equals`
`isNumeric`	Whether the metric is numeric. One of `true`, `false`.	`equals`
`maintainerIds`	A comma-separated list of metric maintainer IDs.	`anyOf`
`maintainerTeamKey`	The metric maintainer team key.	`equals`
`query`	A “fuzzy” search across metric key and name. Supply a string or list of strings to the operator.	`equals`
`tags`	The metric tags.	`contains`
`unitAggregationType`	The metric’s unit aggregation type. One of `sum`, `average`.	`equals`

For example, the filter ?filter=tags contains ["tag1", "tag2", "tag3"] matches metrics that have all three tags.

The documented values for filter query parameters are prior to URL encoding. For example, the [ in ?filter=tags contains ["tag1", "tag2", "tag3"] must be encoded to %5B.

Expanding the metric list response

LaunchDarkly supports expanding the “List metrics” response. By default, the expandable field is not included in the response.

To expand the response, append the expand query parameter and add the following supported field:

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

For example, expand=experimentCount includes the experimentCount field for each metric in the response.

Filtering metrics

Supported fields and operators

Expanding the metric list response

Path parameters

Headers

Query parameters

Response

Errors

Filtering metrics

Supported fields and operators

Expanding the metric list response