Get metric

GET

/api/v2/metrics/:projectKey/:metricKey

GET

/api/v2/metrics/:projectKey/:metricKey

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

1 {
2   "_id": "5902deadbeef667524a01290",
3   "_versionId": "version-id-123abc",
4   "key": "metric-key-123abc",
5   "name": "My metric",
6   "kind": "custom",
7   "_links": {
8     "parent": {
9       "href": "/api/v2/metrics/my-project",
10       "type": "application/json"
11     },
12     "self": {
13       "href": "/api/v2/metrics/my-project/my-metric",
14       "type": "application/json"
15     }
16   },
17   "tags": [],
18   "_creationDate": 1628192791148,
19   "dataSource": {
20     "key": "string",
21     "environmentKey": "string",
22     "_name": "string",
23     "_integrationKey": "string"
24   },
25   "experimentCount": 0,
26   "metricGroupCount": 0,
27   "activeExperimentCount": 2,
28   "activeGuardedRolloutCount": 1,
29   "_version": 1,
30   "_attachedFlagCount": 0,
31   "_site": {},
32   "_access": {
33     "denied": [
34       {
35         "action": "string",
36         "reason": {
37           "effect": "allow",
38           "resources": [
39             "proj/*:env/*;qa_*:/flag/*"
40           ],
41           "notResources": [
42             "string"
43           ],
44           "actions": [
45             "*"
46           ],
47           "notActions": [
48             "string"
49           ],
50           "role_name": "string"
51         }
52       }
53     ],
54     "allowed": [
55       {
56         "action": "string",
57         "reason": {
58           "effect": "allow",
59           "resources": [
60             "proj/*:env/*;qa_*:/flag/*"
61           ],
62           "notResources": [
63             "string"
64           ],
65           "actions": [
66             "*"
67           ],
68           "notActions": [
69             "string"
70           ],
71           "role_name": "string"
72         }
73       }
74     ]
75   },
76   "lastModified": {
77     "date": "2021-08-05T19:46:31.148082Z"
78   },
79   "maintainerId": "569fdeadbeef1644facecafe",
80   "_maintainer": {
81     "_links": {
82       "self": {
83         "href": "/api/v2/members/569f183514f4432160000007",
84         "type": "application/json"
85       }
86     },
87     "_id": "569f183514f4432160000007",
88     "role": "admin",
89     "email": "ariel@acme.com"
90   },
91   "description": "string",
92   "category": "Error monitoring",
93   "isNumeric": true,
94   "successCriteria": "HigherThanBaseline",
95   "unit": "string",
96   "eventKey": "Order placed",
97   "analysisUnits": [
98     "user"
99   ],
100   "filters": {
101     "type": "contextAttribute",
102     "op": "in",
103     "values": [
104       "JP"
105     ],
106     "negate": false
107   },
108   "unitAggregationType": "average",
109   "analysisType": "mean",
110   "percentileValue": 95,
111   "eventDefault": {
112     "disabled": true,
113     "value": 0
114   },
115   "lastSeen": 1,
116   "archived": true,
117   "archivedAt": 1609459200000,
118   "selector": "string",
119   "urls": [
120     "[{\"kind\":\"exact\",\"url\":\"https://www.example.com/page1\"}]"
121   ],
122   "windowStartOffset": 1,
123   "windowEndOffset": 1,
124   "winsorLowerPercentile": 1,
125   "winsorUpperPercentile": 99.5,
126   "winsorExcludeImputed": false,
127   "traceQuery": "service.name = \"checkout\"",
128   "traceValueLocation": "duration",
129   "denominator": {
130     "eventName": "string",
131     "isNumeric": true,
132     "unitAggregationType": "string",
133     "unitAggregationField": "string",
134     "dataSource": {
135       "key": "string",
136       "environmentKey": "string",
137       "_name": "string",
138       "_integrationKey": "string"
139     },
140     "filters": {
141       "type": "contextAttribute",
142       "op": "in",
143       "values": [
144         "JP"
145       ],
146       "negate": false,
147       "attribute": "country",
148       "contextKind": "user"
149     },
150     "windowStartOffset": 1,
151     "windowEndOffset": 1,
152     "winsorLowerPercentile": 1.1,
153     "winsorUpperPercentile": 1.1,
154     "winsorExcludeImputed": true
155   },
156   "experiments": [
157     {
158       "key": "experiment-key-123abc",
159       "name": "Example experiment",
160       "environmentId": "1234a56b7c89d012345e678f",
161       "environmentKey": "production",
162       "creationDate": 1654104600000,
163       "_links": {
164         "parent": {
165           "href": "/api/v2/projects/my-project/environments/my-environment",
166           "type": "application/json"
167         },
168         "self": {
169           "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
170           "type": "application/json"
171         }
172       },
173       "archivedDate": 1654104600000
174     }
175   ],
176   "metricGroups": [
177     {
178       "key": "metric-group-key-123abc",
179       "name": "My metric group",
180       "kind": "funnel",
181       "_links": {
182         "parent": {
183           "href": "/api/v2/projects/my-project",
184           "type": "application/json"
185         },
186         "self": {
187           "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
188           "type": "application/json"
189         }
190       }
191     }
192   ],
193   "lastUsedInExperiment": {
194     "key": "experiment-key-123abc",
195     "name": "Example experiment",
196     "environmentId": "1234a56b7c89d012345e678f",
197     "environmentKey": "production",
198     "creationDate": 1654104600000,
199     "_links": {
200       "parent": {
201         "href": "/api/v2/projects/my-project/environments/my-environment",
202         "type": "application/json"
203       },
204       "self": {
205         "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
206         "type": "application/json"
207       }
208     },
209     "archivedDate": 1654104600000
210   },
211   "lastUsedInGuardedRollout": {
212     "_id": "885ccadf-181b-4a9a-8414-7ad6f7ba2db0",
213     "flagKey": "my-flag",
214     "flagName": "My Flag",
215     "environmentKey": "production",
216     "environmentName": "Production",
217     "status": "monitoring",
218     "creationDate": 1654104600000,
219     "_links": {
220       "self": {
221         "href": "/api/v2/projects/my-project/flags/my-flag/environments/production/measured-rollouts/885ccadf-181b-4a9a-8414-7ad6f7ba2db0",
222         "type": "application/json"
223       }
224     },
225     "flagPurpose": "migration"
226   },
227   "isActive": true,
228   "_attachedFeatures": [
229     {
230       "name": "Example flag",
231       "key": "flag-key-123abc",
232       "_links": {},
233       "_site": {
234         "href": "string",
235         "type": "string"
236       }
237     }
238   ],
239   "randomizationUnits": [
240     "user"
241   ]
242 }

Get information for a single metric from the specific project.

Expanding the metric response

LaunchDarkly supports four fields for expanding the “Get metric” 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 any of the following fields:

experiments includes all experiments from the specific project that use the metric
experimentCount includes the number of experiments from the specific project that use the metric
metricGroups includes all metric groups from the specific project that use the metric
metricGroupCount includes the number of metric groups from the specific project that use the metric

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

Get information for a single metric from the specific project. ### Expanding the metric response LaunchDarkly supports four fields for expanding the "Get metric" 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 any of the following fields: - `experiments` includes all experiments from the specific project that use the metric - `experimentCount` includes the number of experiments from the specific project that use the metric - `metricGroups` includes all metric groups from the specific project that use the metric - `metricGroupCount` includes the number of metric groups from the specific project that use the metric For example, `expand=experiments` includes the `experiments` field in the response.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

metricKeystringRequiredformat: "string"

The metric key

Query parameters

expandstringOptionalformat: "string"

A comma-separated list of properties that can reveal additional information in the response. Supported fields are `experiments`, `experimentCount`, `metricGroups`, `metricGroupCount`, `eventSources`, `guardedRollouts`, `guardedRolloutCount`, `lastUsedInExperiment`, and `lastUsedInGuardedRollout`.

versionIdstringOptionalformat: "string"

The specific version ID of the metric

Response

Metric response

_idstring

The ID of this metric

_versionIdstring

The version ID of the metric

keystring

A unique key to reference the metric

namestring

A human-friendly name for the metric

kindenum

The kind of event the metric tracks

Allowed values:

_linksmap from strings to objects

The location and content type of related resources

tagslist of strings

Tags for the metric

_creationDatelong

Timestamp of when the metric was created

dataSourceobject

experimentCountinteger

The number of experiments using this metric

metricGroupCountinteger

The number of metric groups using this metric

activeExperimentCountinteger

The number of active experiments using this metric

activeGuardedRolloutCountinteger

The number of active guarded rollouts using this metric

_versioninteger

Version of the metric

_attachedFlagCountinteger

The number of feature flags currently attached to this metric

_siteobject

Details on how to access the metric in the LaunchDarkly UI

_accessobject

Details on the allowed and denied actions for this metric

lastModifiedobject

maintainerIdstring

The ID of the member who maintains this metric

_maintainerobject

Details on the member who maintains this metric

descriptionstring

Description of the metric

categorystring

The category of the metric

isNumericboolean

For custom and trace metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false).

successCriteriaenum

For custom and trace metrics, the success criteria

Allowed values:

unitstring

For numeric custom and trace metrics, the unit of measure

eventKeystring

For custom metrics, the event key to use in your code

analysisUnitslist of strings

An array of analysis units allowed for this metric.

filtersobject

The filters narrowing down the audience based on context attributes or event properties.

unitAggregationTypeenum

The method by which multiple unit event values are aggregated

Allowed values:

analysisTypeenum

The method for analyzing metric events

Allowed values:

percentileValueinteger

The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile.

eventDefaultobject

lastSeenlong

Timestamp of most recent data for this metric, at one-hour fidelity

archivedboolean

Whether the metric version is archived

archivedAtlong

Timestamp when the metric version was archived

selectorstring

For click metrics, the CSS selectors

urlslist of maps from strings to any

For click and pageview metrics, the target URLs

windowStartOffsetlong

Not yet implemented - The start of the measurement window, in milliseconds relative to the unit’s first exposure to a flag variation

windowEndOffsetlong

Not yet implemented - The end of the measurement window, in milliseconds relative to the unit’s first exposure to a flag variation

winsorLowerPercentiledouble

Lower winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, defines a two-sided clamp range. Otherwise lower-only winsorization.

winsorUpperPercentiledouble

Upper winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, must be greater than winsorLowerPercentile.

winsorExcludeImputedboolean

When true, the percentile bound calculation excludes imputed zeros. Only meaningful when at least one bound is set and the metric includes units that didn't send events.

traceQuerystring

For trace metrics, the trace query to use for the metric.

traceValueLocationstring

For trace metrics, the location in the trace to use for numeric values.

denominatorobject

For ratio metrics, the denominator event configuration

experimentslist of objects

Experiments that use this metric, including those using a metric group that contains this metric

metricGroupslist of objects

Metric groups that use this metric

lastUsedInExperimentobject

The most recent experiment that used this metric

lastUsedInGuardedRolloutobject

The most recent guarded rollout that used this metric

isActiveboolean

Whether the metric is active

_attachedFeatureslist of objects

Details on the flags attached to this metric

randomizationUnitslist of stringsDeprecated

Deprecated, use analysisUnits instead.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Get information for a single metric from the specific project.

Expanding the metric response

LaunchDarkly supports four fields for expanding the “Get metric” 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 any of the following fields:

experiments includes all experiments from the specific project that use the metric
experimentCount includes the number of experiments from the specific project that use the metric
metricGroups includes all metric groups from the specific project that use the metric
metricGroupCount includes the number of metric groups from the specific project that use the metric

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