Sign in
Metrics

Get metric

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.

get/api/v2/metrics/{projectKey}/{metricKey}

Path parameters

projectKeystring string required

The project key

The project key

metricKeystring string required

The metric key

The metric key

Query parameters

expandstring string

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

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

versionIdstring string

The specific version ID of the metric

The specific version ID of the metric

Response

Metric response

experimentCountinteger

The number of experiments using this metric

metricGroupCountinteger

The number of metric groups using this metric

_idstring required

The ID of this metric

_versionIdstring required

The version ID of the metric

keystring required

A unique key to reference the metric

namestring required

A human-friendly name for the metric

kind'pageview' | 'click' | 'custom' required

The kind of event the metric tracks

_attachedFlagCountinteger

The number of feature flags currently attached to this metric

_linksobject required

The location and content type of related resources

tagsstring[] required

Tags for the metric

_creationDateinteger required
maintainerIdstring

The ID of 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 (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).

successCriteria'HigherThanBaseline' | 'LowerThanBaseline'

For custom metrics, the success criteria

unitstring

For numeric custom metrics, the unit of measure

eventKeystring

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

randomizationUnitsstring[]

An array of randomization units allowed for this metric

unitAggregationType'average' | 'sum'

The method by which multiple unit event values are aggregated

analysisType'mean' | 'percentile'

The method for analyzing metric events

percentileValueinteger

The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>.

isActiveboolean

Whether the metric is active

_versioninteger

Version of the metric

selectorstring

For click metrics, the CSS selectors

urlsUrlMatcher[]

Example response

{
  "_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"
    }
  },
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  },
  "tags": [],
  "lastModified": {
    "date": "2021-08-05T19:46:31.148082Z"
  },
  "maintainerId": "569fdeadbeef1644facecafe",
  "_maintainer": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "firstName": "Ariel",
    "lastName": "Flores",
    "role": "admin",
    "email": "ariel@acme.com"
  },
  "category": "Error monitoring",
  "isNumeric": true,
  "eventKey": "Order placed",
  "randomizationUnits": [
    "user"
  ],
  "filters": {
    "type": "contextAttribute",
    "attribute": "country",
    "values": [
      "JP"
    ],
    "contextKind": "user"
  },
  "unitAggregationType": "average",
  "analysisType": "mean",
  "percentileValue": 95,
  "experiments": [
    {
      "key": "experiment-key-123abc",
      "name": "Example experiment",
      "environmentId": "1234a56b7c89d012345e678f",
      "environmentKey": "production",
      "_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"
        }
      }
    }
  ],
  "isActive": true,
  "_attachedFeatures": [
    {
      "name": "Example flag",
      "key": "flag-key-123abc"
    }
  ],
  "_version": 1
}

Changes