Create metric

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/metrics/{projectKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventKey": "Order placed",
  "isNumeric": false,
  "key": "metric-key-123abc",
  "kind": "custom"
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/metrics/{projectKey}"

payload = {
    "eventKey": "Order placed",
    "isNumeric": False,
    "key": "metric-key-123abc",
    "kind": "custom"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    eventKey: 'Order placed',
    isNumeric: false,
    key: 'metric-key-123abc',
    kind: 'custom'
  })
};

fetch('https://app.launchdarkly.com/api/v2/metrics/{projectKey}', 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/metrics/{projectKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'eventKey' => 'Order placed',
    'isNumeric' => false,
    'key' => 'metric-key-123abc',
    'kind' => 'custom'
  ]),
  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/metrics/{projectKey}"

	payload := strings.NewReader("{\n  \"eventKey\": \"Order placed\",\n  \"isNumeric\": false,\n  \"key\": \"metric-key-123abc\",\n  \"kind\": \"custom\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.launchdarkly.com/api/v2/metrics/{projectKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"eventKey\": \"Order placed\",\n  \"isNumeric\": false,\n  \"key\": \"metric-key-123abc\",\n  \"kind\": \"custom\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/metrics/{projectKey}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"eventKey\": \"Order placed\",\n  \"isNumeric\": false,\n  \"key\": \"metric-key-123abc\",\n  \"kind\": \"custom\"\n}"

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

{
  "_id": "5902deadbeef667524a01290",
  "_versionId": "version-id-123abc",
  "key": "metric-key-123abc",
  "name": "My metric",
  "kind": "custom",
  "_links": {
    "parent": {
      "href": "/api/v2/metrics/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/metrics/my-project/my-metric",
      "type": "application/json"
    }
  },
  "tags": [],
  "_creationDate": "1628192791148",
  "dataSource": {
    "key": "<string>",
    "environmentKey": "<string>",
    "_name": "<string>",
    "_integrationKey": "<string>"
  },
  "experimentCount": 0,
  "metricGroupCount": 0,
  "activeExperimentCount": 2,
  "activeGuardedRolloutCount": 1,
  "_version": 1,
  "_attachedFlagCount": 0,
  "_site": "{\"href\":\"/my-project/metrics/my-metric/details\",\"type\":\"text/html\"}",
  "_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>"
        }
      }
    ]
  },
  "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
  },
  "lastSeen": 123,
  "archived": true,
  "archivedAt": "1609459200000",
  "selector": "<string>",
  "urls": "[{\"kind\":\"exact\",\"url\":\"https://www.example.com/page1\"}]",
  "windowStartOffset": 123,
  "windowEndOffset": 123,
  "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",
      "op": "in",
      "values": [
        "JP"
      ],
      "negate": false,
      "attribute": "country",
      "contextKind": "user"
    },
    "windowStartOffset": 123,
    "windowEndOffset": 123,
    "winsorLowerPercentile": 123,
    "winsorUpperPercentile": 123,
    "winsorIncludeImputed": true
  },
  "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"
    }
  ],
  "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",
    "_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"
  },
  "lastUsedInGuardedRollout": {
    "_id": "885ccadf-181b-4a9a-8414-7ad6f7ba2db0",
    "flagKey": "my-flag",
    "flagName": "My Flag",
    "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"
      }
    },
    "flagPurpose": "migration"
  },
  "isActive": true,
  "_attachedFeatures": [
    {
      "name": "Example flag",
      "key": "flag-key-123abc",
      "_links": {},
      "_site": {
        "href": "<string>",
        "type": "<string>"
      }
    }
  ]
}

{
  "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": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

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

POST

api

metrics

{projectKey}

Create metric

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/metrics/{projectKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventKey": "Order placed",
  "isNumeric": false,
  "key": "metric-key-123abc",
  "kind": "custom"
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/metrics/{projectKey}"

payload = {
    "eventKey": "Order placed",
    "isNumeric": False,
    "key": "metric-key-123abc",
    "kind": "custom"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    eventKey: 'Order placed',
    isNumeric: false,
    key: 'metric-key-123abc',
    kind: 'custom'
  })
};

fetch('https://app.launchdarkly.com/api/v2/metrics/{projectKey}', 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/metrics/{projectKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'eventKey' => 'Order placed',
    'isNumeric' => false,
    'key' => 'metric-key-123abc',
    'kind' => 'custom'
  ]),
  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/metrics/{projectKey}"

	payload := strings.NewReader("{\n  \"eventKey\": \"Order placed\",\n  \"isNumeric\": false,\n  \"key\": \"metric-key-123abc\",\n  \"kind\": \"custom\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.launchdarkly.com/api/v2/metrics/{projectKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"eventKey\": \"Order placed\",\n  \"isNumeric\": false,\n  \"key\": \"metric-key-123abc\",\n  \"kind\": \"custom\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/metrics/{projectKey}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"eventKey\": \"Order placed\",\n  \"isNumeric\": false,\n  \"key\": \"metric-key-123abc\",\n  \"kind\": \"custom\"\n}"

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

{
  "_id": "5902deadbeef667524a01290",
  "_versionId": "version-id-123abc",
  "key": "metric-key-123abc",
  "name": "My metric",
  "kind": "custom",
  "_links": {
    "parent": {
      "href": "/api/v2/metrics/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/metrics/my-project/my-metric",
      "type": "application/json"
    }
  },
  "tags": [],
  "_creationDate": "1628192791148",
  "dataSource": {
    "key": "<string>",
    "environmentKey": "<string>",
    "_name": "<string>",
    "_integrationKey": "<string>"
  },
  "experimentCount": 0,
  "metricGroupCount": 0,
  "activeExperimentCount": 2,
  "activeGuardedRolloutCount": 1,
  "_version": 1,
  "_attachedFlagCount": 0,
  "_site": "{\"href\":\"/my-project/metrics/my-metric/details\",\"type\":\"text/html\"}",
  "_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>"
        }
      }
    ]
  },
  "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
  },
  "lastSeen": 123,
  "archived": true,
  "archivedAt": "1609459200000",
  "selector": "<string>",
  "urls": "[{\"kind\":\"exact\",\"url\":\"https://www.example.com/page1\"}]",
  "windowStartOffset": 123,
  "windowEndOffset": 123,
  "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",
      "op": "in",
      "values": [
        "JP"
      ],
      "negate": false,
      "attribute": "country",
      "contextKind": "user"
    },
    "windowStartOffset": 123,
    "windowEndOffset": 123,
    "winsorLowerPercentile": 123,
    "winsorUpperPercentile": 123,
    "winsorIncludeImputed": true
  },
  "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"
    }
  ],
  "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",
    "_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"
  },
  "lastUsedInGuardedRollout": {
    "_id": "885ccadf-181b-4a9a-8414-7ad6f7ba2db0",
    "flagKey": "my-flag",
    "flagName": "My Flag",
    "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"
      }
    },
    "flagPurpose": "migration"
  },
  "isActive": true,
  "_attachedFeatures": [
    {
      "name": "Example flag",
      "key": "flag-key-123abc",
      "_links": {},
      "_site": {
        "href": "<string>",
        "type": "<string>"
      }
    }
  ]
}

{
  "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": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

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

Body

application/json

key

string

required

A unique key to reference the metric

Example:

"metric-key-123abc"

kind

enum<string>

required

The kind of event your metric will track

Available options:

pageview,

click,

custom,

trace

Example:

"custom"

name

string

A human-friendly name for the metric

Example:

"Example metric"

description

string

Description of the metric

Example:

"optional description"

selector

string

One or more CSS selectors. Required for click metrics only.

Example:

".dropdown-toggle"

urls

object[]

One or more target URLs. Required for click and pageview metrics only.

Show child attributes

Example:

"invalid example"

isNumeric

boolean

Whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). Required for custom and trace metrics only.

Example:

false

unit

string

The unit of measure. Applicable for numeric custom and trace metrics only.

Example:

"orders"

eventKey

string

The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only.

Example:

"Order placed"

successCriteria

enum<string>

Success criteria. Required for custom and trace numeric metrics, optional for custom and trace conversion metrics.

Available options:

HigherThanBaseline,

LowerThanBaseline

Example:

"HigherThanBaseline"

Response

Metric response

_id

string

required

The ID of this metric

Example:

"5902deadbeef667524a01290"

_versionId

string

required

The version ID of the metric

Example:

"version-id-123abc"

key

string

required

A unique key to reference the metric

Example:

"metric-key-123abc"

name

string

required

A human-friendly name for the metric

Example:

"My metric"

kind

enum<string>

required

The kind of event the metric tracks

Available options:

pageview,

click,

custom,

trace

Example:

"custom"

_links

object

required

The location and content type of related resources

Show child attributes

Example:

{
  "parent": {
    "href": "/api/v2/metrics/my-project",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/metrics/my-project/my-metric",
    "type": "application/json"
  }
}