List metrics

GET

/api/v2/metrics/:projectKey

GET

/api/v2/metrics/:projectKey

curl https://app.launchdarkly.com/api/v2/metrics/projectKey \
     -H "Authorization: <apiKey>"

{
  "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": {},
      "_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/569f183514f4432160000007",
            "type": "application/json"
          }
        },
        "_id": "569f183514f4432160000007",
        "role": "admin",
        "email": "ariel@acme.com"
      },
      "description": "string",
      "category": "Error monitoring",
      "isNumeric": true,
      "successCriteria": "HigherThanBaseline",
      "unit": "string",
      "eventKey": "Order placed",
      "analysisUnits": [
        "user"
      ],
      "filters": {
        "type": "contextAttribute",
        "op": "in",
        "values": [
          "JP"
        ],
        "negate": false
      },
      "unitAggregationType": "average",
      "analysisType": "mean",
      "percentileValue": 95,
      "eventDefault": {
        "disabled": true,
        "value": 0
      },
      "lastSeen": 1,
      "archived": true,
      "archivedAt": 1609459200000,
      "selector": "string",
      "urls": [
        "[{\"kind\":\"exact\",\"url\":\"https://www.example.com/page1\"}]"
      ],
      "windowStartOffset": 1,
      "windowEndOffset": 1,
      "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": 1,
        "windowEndOffset": 1,
        "winsorLowerPercentile": 1.1,
        "winsorUpperPercentile": 1.1,
        "winsorIncludeImputed": true
      },
      "randomizationUnits": [
        "user"
      ]
    }
  ],
  "_links": {
    "self": {
      "href": "/api/v2/metrics/my-project?limit=20",
      "type": "application/json"
    }
  },
  "totalCount": 1
}

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 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: |<div style="width:120px">Field</div> |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.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

Query parameters

expandstringOptionalformat: "string"

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

limitlongOptional

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

offsetlongOptional

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.

sortstringOptionalformat: "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.

filterstringOptionalformat: "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.

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

itemslist of objectsOptional

An array of metrics

_linksmap from strings to objectsOptional

The location and content type of related resources

totalCountintegerOptional

Errors

401

Unauthorized Error

404

Not Found Error