@launchdarkly/mcp-server/dist/esm/funcs/metricsList.d.ts

The local [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server for [LaunchDarkly](https://launchdarkly.com/) federal and European Union (EU) environments.

import { LaunchDarklyCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { LaunchDarklyError } from "../models/errors/launchdarklyerror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * List metrics
 *
 * @remarks
 * 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.
 */
export declare function metricsList(client: LaunchDarklyCore, request: operations.GetMetricsRequest, options?: RequestOptions): APIPromise<Result<components.MetricCollectionRep, errors.UnauthorizedErrorRep | errors.NotFoundErrorRep | LaunchDarklyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=metricsList.d.ts.map