Update metric
Patch a metric by key. Updating a metric uses a JSON patch representation of the desired changes. To learn more, read Updates.
Authorization
ApiKey read, writeIn: header
Scope: read, write
Path Parameters
The project key
stringThe metric key
stringRequest Body
application/json
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v2/metrics/string/string" \ -H "Content-Type: application/json" \ -d '[ { "op": "replace", "path": "/name", "value": "my-updated-metric" } ]'{ "experimentCount": 0, "metricGroupCount": 0, "activeExperimentCount": 2, "activeGuardedRolloutCount": 1, "_id": "5902deadbeef667524a01290", "_versionId": "version-id-123abc", "_version": 1, "key": "metric-key-123abc", "name": "My metric", "kind": "custom", "_attachedFlagCount": 0, "_links": { "parent": { "href": "/api/v2/metrics/my-project", "type": "application/json" }, "self": { "href": "/api/v2/metrics/my-project/my-metric", "type": "application/json" } }, "_site": "{\"href\":\"/my-project/metrics/my-metric/details\",\"type\":\"text/html\"}", "_access": { "denied": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ], "allowed": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ] }, "tags": [], "_creationDate": "1628192791148", "lastModified": { "date": "2021-08-05T19:46:31.148082Z" }, "maintainerId": "569fdeadbeef1644facecafe", "_maintainer": "{\"_links\":{\"self\":{\"href\":\"/api/v2/members/569fdeadbeef1644facecafe\",\"type\":\"application/json\"}},\"_id\":\"569fdeadbeef1644facecafe\",\"firstName\":\"Ariel\",\"lastName\":\"Flores\",\"role\":\"owner\",\"email\":\"ariel@acme.com\"}", "description": "string", "category": "Error monitoring", "isNumeric": true, "successCriteria": "HigherThanBaseline", "unit": "string", "eventKey": "Order placed", "randomizationUnits": [ "user" ], "analysisUnits": [ "user" ], "filters": "{\"type\":\"group\",\"op\":\"and\",\"values\":[{\"type\":\"contextAttribute\",\"op\":\"in\",\"contextKind\":\"user\",\"attribute\":\"country\",\"values\":[\"JP\"],\"negate\":false},{\"type\":\"eventProperty\",\"op\":\"in\",\"attribute\":\"category\",\"values\":[\"magic-wands\"],\"negate\":false}]}", "unitAggregationType": "average", "analysisType": "mean", "percentileValue": 95, "eventDefault": { "disabled": true, "value": 0 }, "dataSource": { "key": "string", "environmentKey": "string", "_name": "string", "_integrationKey": "string" }, "lastSeen": 0, "archived": true, "archivedAt": "1609459200000", "selector": "string", "urls": "[{\"kind\":\"exact\",\"url\":\"https://www.example.com/page1\"}]", "windowStartOffset": 0, "windowEndOffset": 0, "winsorLowerPercentile": 1, "winsorUpperPercentile": 99.5, "winsorIncludeImputed": false, "traceQuery": "service.name = \"checkout\"", "traceValueLocation": "duration", "unitAggregationField": "string", "denominator": { "eventName": "string", "isNumeric": true, "unitAggregationType": "string", "unitAggregationField": "string", "valueColumn": "string", "dataSource": { "key": "string", "environmentKey": "string", "_name": "string", "_integrationKey": "string" }, "filters": { "type": "contextAttribute", "attribute": "country", "op": "in", "values": [ "JP" ], "contextKind": "user", "negate": false }, "windowStartOffset": 0, "windowEndOffset": 0, "winsorLowerPercentile": 0, "winsorUpperPercentile": 0, "winsorIncludeImputed": true }, "experiments": [ { "key": "experiment-key-123abc", "name": "Example experiment", "environmentId": "1234a56b7c89d012345e678f", "environmentKey": "production", "creationDate": "1654104600000", "archivedDate": "1654104600000", "_links": { "parent": { "href": "/api/v2/projects/my-project/environments/my-environment", "type": "application/json" }, "self": { "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment", "type": "application/json" } } } ], "metricGroups": [ { "key": "metric-group-key-123abc", "name": "My metric group", "kind": "funnel", "_links": { "parent": { "href": "/api/v2/projects/my-project", "type": "application/json" }, "self": { "href": "/api/v2/projects/my-project/metric-groups/my-metric-group", "type": "application/json" } } } ], "lastUsedInExperiment": { "key": "experiment-key-123abc", "name": "Example experiment", "environmentId": "1234a56b7c89d012345e678f", "environmentKey": "production", "creationDate": "1654104600000", "archivedDate": "1654104600000", "_links": { "parent": { "href": "/api/v2/projects/my-project/environments/my-environment", "type": "application/json" }, "self": { "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment", "type": "application/json" } } }, "lastUsedInGuardedRollout": { "_id": "885ccadf-181b-4a9a-8414-7ad6f7ba2db0", "flagKey": "my-flag", "flagName": "My Flag", "flagPurpose": "migration", "environmentKey": "production", "environmentName": "Production", "status": "monitoring", "creationDate": "1654104600000", "_links": { "self": { "href": "/internal/projects/my-project/environments/production/automated-releases/885ccadf-181b-4a9a-8414-7ad6f7ba2db0", "type": "application/json" } } }, "isActive": true, "_attachedFeatures": [ { "name": "Example flag", "key": "flag-key-123abc", "_links": { "property1": { "href": "string", "type": "string" }, "property2": { "href": "string", "type": "string" } }, "_site": { "href": "string", "type": "string" } } ]}Get metric GET
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.
Delete metric DELETE
Delete a metric by key.