@launchdarkly/mcp-server/dist/commonjs/funcs/experimentsList.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";
/**
 * Get experiments
 *
 * @remarks
 * Get details about all experiments in an environment.
 *
 * ### Filtering experiments
 *
 * LaunchDarkly supports the `filter` query param for filtering, with the following fields:
 *
 * - `flagKey` filters for only experiments that use the flag with the given key.
 * - `metricKey` filters for only experiments that use the metric with the given key.
 * - `status` filters for only experiments with an iteration with the given status. An iteration can have the status `not_started`, `running` or `stopped`.
 *
 * For example, `filter=flagKey:my-flag,status:running,metricKey:page-load-ms` filters for experiments for the given flag key and the given metric key which have a currently running iteration.
 *
 * ### Expanding the experiments response
 *
 * LaunchDarkly supports five fields for expanding the "Get experiments" 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:
 *
 * - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response.
 * - `draftIteration` includes the iteration which has not been started yet, if any.
 * - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response.
 * - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response.
 * - `analysisConfig` includes the analysis configuration for the experiment, such as the Bayesian threshold or significance threshold.
 *
 * For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response.
 */
export declare function experimentsList(client: LaunchDarklyCore, request: operations.GetExperimentsRequest, options?: RequestOptions): APIPromise<Result<components.ExperimentCollectionRep, errors.InvalidRequestErrorRep | errors.UnauthorizedErrorRep | errors.ForbiddenErrorRep | errors.NotFoundErrorRep | errors.MethodNotAllowedErrorRep | errors.RateLimitedErrorRep | LaunchDarklyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=experimentsList.d.ts.map