Update metric

PATCH

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

PATCH

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

1 curl -X PATCH https://app.launchdarkly.com/api/v2/metrics/projectKey/metricKey \
2      -H "Authorization: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '[
5   {
6     "op": "replace",
7     "path": "/name"
8   }
9 ]'

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   "randomizationUnits": [
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   "experiments": [
123     {
124       "key": "experiment-key-123abc",
125       "name": "Example experiment",
126       "environmentId": "1234a56b7c89d012345e678f",
127       "environmentKey": "production",
128       "creationDate": 1654104600000,
129       "_links": {
130         "parent": {
131           "href": "/api/v2/projects/my-project/environments/my-environment",
132           "type": "application/json"
133         },
134         "self": {
135           "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
136           "type": "application/json"
137         }
138       },
139       "archivedDate": 1654104600000
140     }
141   ],
142   "metricGroups": [
143     {
144       "key": "metric-group-key-123abc",
145       "name": "My metric group",
146       "kind": "funnel",
147       "_links": {
148         "parent": {
149           "href": "/api/v2/projects/my-project",
150           "type": "application/json"
151         },
152         "self": {
153           "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
154           "type": "application/json"
155         }
156       }
157     }
158   ],
159   "lastUsedInExperiment": {
160     "key": "experiment-key-123abc",
161     "name": "Example experiment",
162     "environmentId": "1234a56b7c89d012345e678f",
163     "environmentKey": "production",
164     "creationDate": 1654104600000,
165     "_links": {
166       "parent": {
167         "href": "/api/v2/projects/my-project/environments/my-environment",
168         "type": "application/json"
169       },
170       "self": {
171         "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
172         "type": "application/json"
173       }
174     },
175     "archivedDate": 1654104600000
176   },
177   "lastUsedInGuardedRollout": {
178     "_id": "885ccadf-181b-4a9a-8414-7ad6f7ba2db0",
179     "flagKey": "my-flag",
180     "flagName": "My Flag",
181     "environmentKey": "production",
182     "environmentName": "Production",
183     "status": "monitoring",
184     "creationDate": 1654104600000,
185     "_links": {
186       "self": {
187         "href": "/api/v2/projects/my-project/flags/my-flag/environments/production/measured-rollouts/885ccadf-181b-4a9a-8414-7ad6f7ba2db0",
188         "type": "application/json"
189       }
190     },
191     "flagPurpose": "migration"
192   },
193   "isActive": true,
194   "_attachedFeatures": [
195     {
196       "name": "Example flag",
197       "key": "flag-key-123abc",
198       "_links": {},
199       "_site": {
200         "href": "string",
201         "type": "string"
202       }
203     }
204   ]
205 }

Patch a metric by key. Updating a metric uses a JSON patch representation of the desired changes. To learn more, read Updates.

Patch a metric by key. Updating a metric uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

metricKeystringRequiredformat: "string"

The metric key

Request

This endpoint expects a list of objects.

opstringRequired

The type of operation to perform

pathstringRequired

A JSON Pointer string specifying the part of the document to operate on

valueanyOptional

A JSON value used in "add", "replace", and "test" operations

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 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 metrics, the success criteria

Allowed values:

unitstring

For numeric custom metrics, the unit of measure

eventKeystring

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

randomizationUnitslist of strings

An array of randomization 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

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

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error