--- title: "List metrics" method: GET path: "/api/v2/experiments/metrics" tags: ["Experiments"] --- # List metrics `GET /api/v2/experiments/metrics` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v2/experiments/metrics` - Auth: one of: - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` - OAuth 2 - Authorization code: `/oauth2/v1/authorize` - Token URL: `/oauth2/v1/token` scopes: `product_analytics_metrics_read` - TypeScript: (a function with typed inputs; its response is checked against the schema) List metrics. Returns a paginated list of the experiment metrics defined for the organization. ## Query parameters - `include` string[]: Optional fields to include. Repeat this parameter to request several fields. `counts` adds experiment_count on each metric, which costs an extra aggregate query. - `page[limit]` integer: Maximum number of results to return. Defaults to 25 when omitted, and is capped at 50 (larger values are clamped to 50). The response includes meta.page (with total) and pagination links. - `page[offset]` integer: Number of results to skip for pagination. Defaults to 0 when omitted. - `search` string: Find metrics whose names contain the search text, regardless of case. - `sort` string: Sort field: name, created_at, or updated_at. Prefix with `-` for descending (for example, `-created_at`). A single field only; a comma-separated list is rejected. Defaults to created_at descending. ## Response `200` OK - ExperimentsMetricV2DTOArray: List of metric resources with pagination information. - `data` ExperimentsMetricV2DTOData[], required: Resources returned in this response. - `attributes` ExperimentsMetricV2DTODataAttributes: Details of the metric. - `certified_at` string, date-time, nullable: Time when this resource was certified. - `created_at` string, date-time: Time when this resource was created. - `data_source_type` 'DATADOG' | 'DATADOG_REFERENCE_TABLE' | 'CUSTOMER_WAREHOUSE' | 'IMPORTED' | 'UNKNOWN': Source of the data used to calculate the metric. - `denominator_aggregation` ExperimentsMetricV2DTODataAttributesNumeratorAggregation, nullable: Source measure and aggregation settings for a metric value. - `aging_threshold_days` integer: Stored aging threshold in days. The subject aging filter uses the aggregation window end and unit. - `datadog_metric_measure` ExperimentsMetricV2DTODataAttributesPercentileAggregationDatadogMetricMeasure: Datadog source and query that supply values for the metric. - `column_name` string: Name of the Datadog event field used by this measure. - `column_type` string: Data type of the source column. - `filters` unknown - `name` string: Display name of the Datadog measure. - `query` string: Query used to retrieve the Datadog measure. - `source_definition_filter` unknown - `source_subtype` string: Subtype of the Datadog data source. - `source_type` string: Type of Datadog data source used for the measure. - `enable_aging_subject_filter` boolean: Whether to exclude subjects whose observation time is shorter than the aggregation window. - `operation` string: Aggregation applied to the selected measure. - `pipeline_column_suffix` string: Suffix used to identify this value in pipeline output columns. - `property_filters` ExperimentsMetricPropertyFilterGroup[]: Filters applied to the metric aggregation. - ExperimentsMetricPropertyFilter[]: Metric property filters combined with AND. - `measure_id` string: ID of the measure evaluated by the filter. - `operation` string: Comparison applied by the filter. - `property_id` string: ID of the property evaluated by the filter. - `values` string[]: Values used by the filter's comparison. - `threshold_aggregation_type` string: Aggregation used to evaluate the threshold. - `threshold_breach_value` number, double: Value used to determine whether the threshold is breached. - `threshold_comparison_operator` string: Comparison applied between the aggregated value and the threshold. - `threshold_timeframe_dimension` string: Time unit used for the threshold evaluation window. - `threshold_timeframe_value` number, double: Size of the threshold evaluation window. - `timeframe_end_value` number, double: End of the aggregation window in the specified time unit. - `timeframe_start_value` number, double: Start of the aggregation window in the specified time unit. - `timeframe_unit` string: Time unit used for the aggregation window. - `warehouse_metric_measure` ExperimentsMetricV2DTODataAttributesPercentileAggregationWarehouseMetricMeasure: Warehouse measure that supplies values for the metric. - `id` string: ID of the measure. - `pipeline_column_suffix` string: Suffix used to identify this value in pipeline output columns. - `winsor_lower_fixed_value` number, double: Fixed lower bound used to cap metric values. - `winsor_lower_percentile` number, double: Percentile used to determine the lower bound for capped metric values. - `winsor_upper_fixed_value` number, double: Fixed upper bound used to cap metric values. - `winsor_upper_percentile` number, double: Percentile used to determine the upper bound for capped metric values. - `winsorization_strategy` string: Method used to cap extreme metric values. - `description` string: Text that explains the metric. - `desired_change` 'METRIC_INCREASES' | 'METRIC_DECREASES' | 'UNKNOWN': Direction of metric change considered desirable. - `experiment_count` integer, nullable: Number of experiments that reference this resource. - `format_as_percent` boolean: Whether to display the metric value as a percentage. - `guardrail_cutoff_threshold` number, double, nullable: Threshold used when evaluating this metric as a guardrail. - `metric_type` 'SIMPLE' | 'RATIO' | 'PERCENTILE' | 'UNKNOWN': Type of metric calculation. - `migration_metadata` unknown - `name` string: Display name of the metric. - `numerator_aggregation` ExperimentsMetricV2DTODataAttributesNumeratorAggregation, nullable: Source measure and aggregation settings for a metric value. - `aging_threshold_days` integer: Stored aging threshold in days. The subject aging filter uses the aggregation window end and unit. - `datadog_metric_measure` ExperimentsMetricV2DTODataAttributesPercentileAggregationDatadogMetricMeasure: Datadog source and query that supply values for the metric. - `column_name` string: Name of the Datadog event field used by this measure. - `column_type` string: Data type of the source column. - `filters` unknown - `name` string: Display name of the Datadog measure. - `query` string: Query used to retrieve the Datadog measure. - `source_definition_filter` unknown - `source_subtype` string: Subtype of the Datadog data source. - `source_type` string: Type of Datadog data source used for the measure. - `enable_aging_subject_filter` boolean: Whether to exclude subjects whose observation time is shorter than the aggregation window. - `operation` string: Aggregation applied to the selected measure. - `pipeline_column_suffix` string: Suffix used to identify this value in pipeline output columns. - `property_filters` ExperimentsMetricPropertyFilterGroup[]: Filters applied to the metric aggregation. - ExperimentsMetricPropertyFilter[]: Metric property filters combined with AND. - `measure_id` string: ID of the measure evaluated by the filter. - `operation` string: Comparison applied by the filter. - `property_id` string: ID of the property evaluated by the filter. - `values` string[]: Values used by the filter's comparison. - `threshold_aggregation_type` string: Aggregation used to evaluate the threshold. - `threshold_breach_value` number, double: Value used to determine whether the threshold is breached. - `threshold_comparison_operator` string: Comparison applied between the aggregated value and the threshold. - `threshold_timeframe_dimension` string: Time unit used for the threshold evaluation window. - `threshold_timeframe_value` number, double: Size of the threshold evaluation window. - `timeframe_end_value` number, double: End of the aggregation window in the specified time unit. - `timeframe_start_value` number, double: Start of the aggregation window in the specified time unit. - `timeframe_unit` string: Time unit used for the aggregation window. - `warehouse_metric_measure` ExperimentsMetricV2DTODataAttributesPercentileAggregationWarehouseMetricMeasure: Warehouse measure that supplies values for the metric. - `id` string: ID of the measure. - `pipeline_column_suffix` string: Suffix used to identify this value in pipeline output columns. - `winsor_lower_fixed_value` number, double: Fixed lower bound used to cap metric values. - `winsor_lower_percentile` number, double: Percentile used to determine the lower bound for capped metric values. - `winsor_upper_fixed_value` number, double: Fixed upper bound used to cap metric values. - `winsor_upper_percentile` number, double: Percentile used to determine the upper bound for capped metric values. - `winsorization_strategy` string: Method used to cap extreme metric values. - `percentile_aggregation` ExperimentsMetricV2DTODataAttributesPercentileAggregation, nullable: Source measure and settings for a percentile metric. - `datadog_metric_measure` ExperimentsMetricV2DTODataAttributesPercentileAggregationDatadogMetricMeasure: Datadog source and query that supply values for the metric. - `column_name` string: Name of the Datadog event field used by this measure. - `column_type` string: Data type of the source column. - `filters` unknown - `name` string: Display name of the Datadog measure. - `query` string: Query used to retrieve the Datadog measure. - `source_definition_filter` unknown - `source_subtype` string: Subtype of the Datadog data source. - `source_type` string: Type of Datadog data source used for the measure. - `percentile` number, double: Percentile calculated from the selected measure. - `pipeline_column_suffix` string: Suffix used to identify this value in pipeline output columns. - `property_filters` ExperimentsMetricPropertyFilterGroup[]: Filters applied to the metric aggregation. - ExperimentsMetricPropertyFilter[]: Metric property filters combined with AND. - `measure_id` string: ID of the measure evaluated by the filter. - `operation` string: Comparison applied by the filter. - `property_id` string: ID of the property evaluated by the filter. - `values` string[]: Values used by the filter's comparison. - `warehouse_metric_measure` ExperimentsMetricV2DTODataAttributesPercentileAggregationWarehouseMetricMeasure: Warehouse measure that supplies values for the metric. - `id` string: ID of the measure. - `pipeline_column_suffix` string: Suffix used to identify this value in pipeline output columns. - `reference_url` string: URL with supporting information about the metric. - `updated_at` string, date-time: Time when this resource was last updated. - `id` string, uuid, required: ID of the metric. - `type` 'metrics', required: The metric resource type. - `links` ExperimentsOffsetLinks: Links for navigating a paginated result set. - `first` string: URL of the first page of results. - `last` string: URL of the last page of results. - `next` string: URL of the next page of results. - `prev` string: URL of the previous page of results. - `self` string: URL of the current page of results. - `meta` ExperimentsOffsetMeta: Pagination information for a list response. - `page` ExperimentsOffsetMetaPage: Result counts and offsets for a page of results. - `first_offset` integer: Offset of the first page of results. - `last_offset` integer, nullable: Offset of the last page of results. - `limit` integer: Maximum number of results returned in one page. - `next_offset` integer, nullable: Offset of the next page of results. - `offset` integer: Number of results skipped before this page. - `prev_offset` integer, nullable: Offset of the previous page of results. - `total` integer, nullable: Total number of matching results across all pages. - `type` string: Pagination method used for this result set. ## Other responses - `400`: Invalid query parameter: bad page[offset]/page[limit], or unknown sort field. - `401`: Missing or invalid authentication (dd-api-key + dd-application-key headers, or a valid user session). - `403`: Authenticated caller lacks the product_analytics_metrics_read permission. - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)