Patch metric group - LaunchDarkly Documentation

PATCH

api

projects

{projectKey}

metric-groups

{metricGroupKey}

Patch metric group

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "replace",
    "path": "/name",
    "value": "my-updated-metric-group"
  }
]
'

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}"

payload = [
    {
        "op": "replace",
        "path": "/name",
        "value": "my-updated-metric-group"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{op: 'replace', path: '/name', value: 'my-updated-metric-group'}])
};

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'op' => 'replace',
        'path' => '/name',
        'value' => 'my-updated-metric-group'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}"

	payload := strings.NewReader("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"my-updated-metric-group\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"my-updated-metric-group\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"my-updated-metric-group\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "_id": "bc3e5be1-02d2-40c7-9926-26d0aacd7aab",
  "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"
    }
  },
  "tags": [
    "ops"
  ],
  "_creationDate": "1628192791148",
  "_lastModified": "1628192791148",
  "maintainer": {
    "member": {
      "_links": {
        "self": {
          "href": "/api/v2/members/569f183514f4432160000007",
          "type": "application/json"
        }
      },
      "_id": "569f183514f4432160000007",
      "role": "admin",
      "email": "ariel@acme.com",
      "firstName": "Ariel",
      "lastName": "Flores"
    },
    "team": {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team",
      "_links": {}
    }
  },
  "metrics": [
    {
      "key": "metric-key-123abc",
      "name": "Example metric",
      "kind": "custom",
      "_links": {
        "self": {
          "href": "/api/v2/metrics/my-project/my-metric",
          "type": "application/json"
        }
      },
      "_versionId": "version-id-123abc",
      "isNumeric": true,
      "unitAggregationType": "sum",
      "eventKey": "event-key-123abc",
      "nameInGroup": "Step 1",
      "randomizationUnits": [
        "user"
      ]
    }
  ],
  "_version": 1,
  "description": "Description of the metric group",
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "experiments": [
    {
      "key": "experiment-key-123abc",
      "name": "Example experiment",
      "environmentId": "1234a56b7c89d012345e678f",
      "environmentKey": "production",
      "creationDate": "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"
        }
      },
      "archivedDate": "1654104600000"
    }
  ],
  "experimentCount": 0,
  "activeExperimentCount": 0,
  "activeGuardedRolloutCount": 0
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "method_not_allowed",
  "message": "Method not allowed"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Path Parameters

projectKey

string<string>

required

The project key

metricGroupKey

string<string>

required

The metric group key

Body

application/json

string

required

The type of operation to perform

Example:

"replace"

path

string

required

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

Example:

"/exampleField"

value

any

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

Example:

"new example value"

Response

Metric group response

_id

string

required

The ID of this metric group

Example:

"bc3e5be1-02d2-40c7-9926-26d0aacd7aab"

key

string

required

A unique key to reference the metric group

Example:

"metric-group-key-123abc"

name

string

required

A human-friendly name for the metric group

Example:

"My metric group"

kind

enum<string>

required

The type of the metric group

Available options:

funnel,

standard

Example:

"funnel"

_links

object

required

The location and content type of related resources

Show child attributes

Example:

{
  "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"
  }
}

tags

string[]

required

Tags for the metric group

Example:

["ops"]

_creationDate

integer<int64>

required

Timestamp of when the metric group was created

Example:

"1628192791148"

_lastModified

integer<int64>

required

Timestamp of when the metric group was last modified

Example:

"1628192791148"

maintainer

object

required

The maintainer of this metric

Show child attributes

metrics

object[]

required

An ordered list of the metrics in this metric group

Show child attributes

_version

integer

required

The version of this metric group

Example:

1

description

string

Description of the metric group

Example:

"Description of the metric group"

_access

object

Details on the allowed and denied actions for this metric group

Show child attributes

experiments

object[]

Experiments that use this metric group. Only included if specified in the expand query parameter in a getMetricGroup request.

Show child attributes

experimentCount

integer

The number of experiments using this metric group

Example:

0

activeExperimentCount

integer

The number of active experiments using this metric group

Example:

0

activeGuardedRolloutCount

integer

The number of active guarded rollouts using this metric group

Example:

0

⌘I

Patch metric group

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "replace",
    "path": "/name",
    "value": "my-updated-metric-group"
  }
]
'

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}"

payload = [
    {
        "op": "replace",
        "path": "/name",
        "value": "my-updated-metric-group"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{op: 'replace', path: '/name', value: 'my-updated-metric-group'}])
};

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'op' => 'replace',
        'path' => '/name',
        'value' => 'my-updated-metric-group'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}"

	payload := strings.NewReader("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"my-updated-metric-group\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"my-updated-metric-group\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"my-updated-metric-group\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "_id": "bc3e5be1-02d2-40c7-9926-26d0aacd7aab",
  "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"
    }
  },
  "tags": [
    "ops"
  ],
  "_creationDate": "1628192791148",
  "_lastModified": "1628192791148",
  "maintainer": {
    "member": {
      "_links": {
        "self": {
          "href": "/api/v2/members/569f183514f4432160000007",
          "type": "application/json"
        }
      },
      "_id": "569f183514f4432160000007",
      "role": "admin",
      "email": "ariel@acme.com",
      "firstName": "Ariel",
      "lastName": "Flores"
    },
    "team": {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team",
      "_links": {}
    }
  },
  "metrics": [
    {
      "key": "metric-key-123abc",
      "name": "Example metric",
      "kind": "custom",
      "_links": {
        "self": {
          "href": "/api/v2/metrics/my-project/my-metric",
          "type": "application/json"
        }
      },
      "_versionId": "version-id-123abc",
      "isNumeric": true,
      "unitAggregationType": "sum",
      "eventKey": "event-key-123abc",
      "nameInGroup": "Step 1",
      "randomizationUnits": [
        "user"
      ]
    }
  ],
  "_version": 1,
  "description": "Description of the metric group",
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "experiments": [
    {
      "key": "experiment-key-123abc",
      "name": "Example experiment",
      "environmentId": "1234a56b7c89d012345e678f",
      "environmentKey": "production",
      "creationDate": "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"
        }
      },
      "archivedDate": "1654104600000"
    }
  ],
  "experimentCount": 0,
  "activeExperimentCount": 0,
  "activeGuardedRolloutCount": 0
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "method_not_allowed",
  "message": "Method not allowed"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}