List metrics

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/metrics/{projectKey} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "items": [
    {
      "_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
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/api/v2/metrics/my-project?limit=20",
      "type": "application/json"
    }
  },
  "totalCount": 123
}

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

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

List metrics

Get a list of all metrics for the specified project.

Filtering metrics

The filter parameter supports the following operators: contains, equals, anyOf.

Supported fields and operators

You can only filter certain fields in metrics when using the filter parameter. Additionally, you can only filter some fields with certain operators.

When you search for metrics, the filter parameter supports the following fields and operators:

Field	Description	Supported operators
`dataSourceKeys`	The data source that provides events for this metric (for example, “launchdarkly-hosted”).	`anyOf`, `notEquals`
`eventKeys`	The metric event key.	`anyOf`
`eventKind`	The metric event kind. One of `custom`, `pageview`, `click`.	`equals`
`hasConnections`	Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`.	`equals`
`isNumeric`	Whether the metric is numeric. One of `true`, `false`.	`equals`
`maintainerIds`	A comma-separated list of metric maintainer IDs.	`anyOf`
`maintainerTeamKey`	The metric maintainer team key.	`equals`
`metricUsedIn`	Filter by where the metric is used. One of `experiments`, `guarded_rollouts`, `any`, `none`.	`equals`
`query`	A “fuzzy” search across metric key and name. Supply a string or list of strings to the operator.	`equals`
`tags`	The metric tags.	`contains`
`unitAggregationType`	The metric’s unit aggregation type. One of `sum`, `average`.	`equals`
`versionIds`	The metric version number.	`anyOf`
`view`	The view used to restrict access to the metric.	`equals`

For example, the filter ?filter=tags contains ["tag1", "tag2", "tag3"] matches metrics that have all three tags.

The documented values for filter query parameters are prior to URL encoding. For example, the [ in ?filter=tags contains ["tag1", "tag2", "tag3"] must be encoded to %5B.

Expanding the metric list response

LaunchDarkly supports expanding the “List metrics” response. By default, the expandable field is not included in the response.

To expand the response, append the expand query parameter and add the following supported field:

experimentCount includes the number of experiments from the specific project that use the metric

For example, expand=experimentCount includes the experimentCount field for each metric in the response.

GET

api

metrics

{projectKey}

List metrics

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/metrics/{projectKey} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "items": [
    {
      "_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
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/api/v2/metrics/my-project?limit=20",
      "type": "application/json"
    }
  },
  "totalCount": 123
}

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

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

Authorizations

Authorization

string

header

required

Path Parameters

projectKey

string<string>

required

The project key

Query Parameters

expand

string<string>

A comma-separated list of properties that can reveal additional information in the response.

limit

integer<int64>

The number of metrics to return in the response. Defaults to 20. Maximum limit is 50.

offset

integer<int64>

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items.

sort

string<string>

A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by createdAt or name.

filter

string<string>

A comma-separated list of filters. This endpoint accepts filtering by query, tags, eventKind, isNumeric, unitAggregationType, hasConnections, maintainerIds, maintainerTeamKey, view, dataSourceKeys, metricUsedIn, eventKeys, and versionIds. To learn more about the filter syntax, read the 'Filtering metrics' section above.

Response

Metrics collection response

items

object[]

An array of metrics

Show child attributes

_links

object

The location and content type of related resources

Show child attributes

Example:

{
  "self": {
    "href": "/api/v2/metrics/my-project?limit=20",
    "type": "application/json"
  }
}

totalCount

integer