Datadog/metrics
@webframp/datadog/metricsv2026.07.20.11
01README
Datadog Metrics — metric queries, submissions, tag configurations, and metadata
02Release Notes
2026.07.20.11
Added: Initial code-generated release of @webframp/datadog/metrics with 14 methods covering the Datadog metrics API surface.
03Models
@webframp/datadog/metricsv2026.07.20.11datadog/metrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiKey | string | Datadog API key (DD-API-KEY) |
| appKey | string | Datadog application key (DD-APPLICATION-KEY) |
| site | enum | Datadog site |
fn list_tag_configurations(filter_configured?: boolean, filter_is_configurable?: boolean, filter_tags_configured?: string, filter_metric_type?: string, filter_include_percentiles?: boolean, filter_queried?: boolean, filter_queried_window_seconds?: number, filter_tags?: string, filter_related_assets?: boolean, include?: string, sort?: string, window_seconds?: number)
Get a list of metrics
| Argument | Type | Description |
|---|---|---|
| filter_configured? | boolean | Only return custom metrics that have been configured (`true`) or not configur... |
| filter_is_configurable? | boolean | Only return metrics that are eligible (`true`) or ineligible (`false`) for co... |
| filter_tags_configured? | string | Only return metrics that have the given tag key(s) in their Metrics Without L... |
| filter_metric_type? | string | Only return metrics of the given metric type. |
| filter_include_percentiles? | boolean | |
| filter_queried? | boolean | Only return metrics that have been queried (true) or not queried (false) in t... |
| filter_queried_window_seconds? | number | This parameter has no effect unless `filter[queried]` is also set. Only retur... |
| filter_tags? | string | Only return metrics that were submitted with tags matching this expression. Y... |
| filter_related_assets? | boolean | Only return metrics that are used in at least one dashboard, monitor, noteboo... |
| include? | string | Include related resources in the response. Set to `metric_volumes` to include... |
| sort? | string | Sort results by metric volume. Prefix a key with `-` for descending order. Su... |
| window_seconds? | number | Only return metrics that have been actively reporting in the specified window... |
fn list_active_metric_configurations(metric_name: string, window_seconds?: number)
List active tags and aggregations
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
| window_seconds? | number |
fn list_tags_by_metric_name(metric_name: string, window_seconds?: number, filter_tags?: string, filter_match?: string, filter_include_tag_values?: boolean, filter_allow_partial?: boolean)
List tags by metric name
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
| window_seconds? | number | The number of seconds of look back (from now) to query for tag data. Default ... |
| filter_tags? | string | Filter results to tags from data points that have the specified tags. For exa... |
| filter_match? | string | Filter returned tags to those matching a substring. For example, `filter[matc... |
| filter_include_tag_values? | boolean | Whether to include tag values in the response. Defaults to true. |
| filter_allow_partial? | boolean | Whether to allow partial results. Defaults to false. |
fn list_metric_assets(metric_name: string)
Related Assets to a Metric
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
fn estimate_metrics_output_series(metric_name: string, filter_groups?: string, filter_hours_ago?: number, filter_num_aggregations?: number, filter_pct?: boolean, filter_timespan_h?: number)
Tag Configuration Cardinality Estimator
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
| filter_groups? | string | Comma-separated list of tag keys that the metric is configured to query with.... |
| filter_hours_ago? | number | The number of hours of look back (from now) to estimate cardinality with. If ... |
| filter_num_aggregations? | number | Deprecated. Number of aggregations has no impact on volume. |
| filter_pct? | boolean | A boolean, for distribution metrics only, to estimate cardinality if the metr... |
| filter_timespan_h? | number | A window, in hours, from the look back to estimate cardinality with. The mini... |
fn get_metric_tag_cardinality_details(metric_name: string)
Get tag key cardinality details
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
fn list_tag_configuration_by_name(metric_name: string)
List tag configuration by name
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
fn create_tag_configuration(metric_name: string, aggregations?: unknown, exclude_tags_mode?: boolean, include_percentiles?: boolean, metric_type: unknown, tags: array)
Create a tag configuration
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
| aggregations? | unknown | |
| exclude_tags_mode? | boolean | When set to true, the configuration will exclude the configured tags and incl... |
| include_percentiles? | boolean | Toggle to include/exclude percentiles for a distribution metric. Defaults to ... |
| metric_type | unknown | |
| tags | array | A list of tag keys that will be queryable for your metric. |
fn update_tag_configuration(metric_name: string, aggregations?: unknown, exclude_tags_mode?: boolean, include_percentiles?: boolean, tags?: array)
Update a tag configuration
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
| aggregations? | unknown | |
| exclude_tags_mode? | boolean | When set to true, the configuration will exclude the configured tags and incl... |
| include_percentiles? | boolean | Toggle to include/exclude percentiles for a distribution metric. Defaults to ... |
| tags? | array | A list of tag keys that will be queryable for your metric. |
fn delete_tag_configuration(metric_name: string)
Delete a tag configuration
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
fn list_volumes_by_metric_name(metric_name: string, window_seconds?: number)
List distinct metric volumes by metric name
| Argument | Type | Description |
|---|---|---|
| metric_name | string | The name of the metric. |
| window_seconds? | number |
fn query_scalar_data(formulas?: array, from: number, queries: unknown, to: number)
Query scalar data across multiple products
| Argument | Type | Description |
|---|---|---|
| formulas? | array | List of formulas to be calculated and returned as responses. |
| from | number | Start date (inclusive) of the query in milliseconds since the Unix epoch. |
| queries | unknown | |
| to | number | End date (exclusive) of the query in milliseconds since the Unix epoch. |
fn query_timeseries_data(formulas?: array, from: number, interval?: number, queries: unknown, to: number)
Query timeseries data across multiple products
| Argument | Type | Description |
|---|---|---|
| formulas? | array | List of formulas to be calculated and returned as responses. |
| from | number | Start date (inclusive) of the query in milliseconds since the Unix epoch. |
| interval? | number | A time interval in milliseconds. May be overridden by a larger interval if th... |
| queries | unknown | |
| to | number | End date (exclusive) of the query in milliseconds since the Unix epoch. |
fn submit_metrics(series: array)
Submit metrics
| Argument | Type | Description |
|---|---|---|
| series | array | A list of timeseries to submit to Datadog. |
Resources
tag_configurations(infinite)— Get a list of metrics
list_active_metric_configurations(infinite)— List active tags and aggregations
tags_by_metric_name(infinite)— List tags by metric name
list_metric_assets(infinite)— Related Assets to a Metric
estimate_metrics_output_series(infinite)— Tag Configuration Cardinality Estimator
metric_tag_cardinality_details(infinite)— Get tag key cardinality details
list_tag_configuration_by_name(infinite)— List tag configuration by name
tag_configuration(infinite)— Create a tag configuration
list_volumes_by_metric_name(infinite)— List distinct metric volumes by metric name
query_scalar_data(infinite)— Query scalar data across multiple products
query_timeseries_data(infinite)— Query timeseries data across multiple products
submit_metrics(infinite)— Submit metrics
04Stats
A
100 / 100
Downloads
2
Archive size
18.6 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels