/datadog-observability | Type: Application | PCID required: Yes
Tools
datadog_observability_aggregate_logs
Aggregate events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
compute | object[] | No | — | The list of metrics or timeseries to compute for the retrieved buckets. |
filter | object | No | — | The search and filter query settings |
group_by | object[] | No | — | The rules for the group by |
options | object | No | — | Global query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results. |
page | object | No | — | Paging settings |
datadog_observability_aggregate_rumevents
Aggregate RUM events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
compute | object[] | No | — | The list of metrics or timeseries to compute for the retrieved buckets. |
filter | object | No | — | The search and filter query settings. |
group_by | object[] | No | — | The rules for the group by. |
options | object | No | — | Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails. |
page | object | No | — | Paging attributes for listing events. |
datadog_observability_aggregate_spans
Aggregate spans Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | No | — | The object containing the query content. |
datadog_observability_estimate_metrics_output_series
Tag Configuration Cardinality Estimator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metric_name | string | Yes | — | The name of the metric. |
filter[groups] | string | No | — | Filtered tag keys that the metric is configured to query with. |
filter[hours_ago] | integer | No | — | The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours. |
filter[num_aggregations] | integer | No | — | Deprecated. Number of aggregations has no impact on volume. |
filter[pct] | boolean | No | — | A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators. |
filter[timespan_h] | integer | No | — | A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour. |
datadog_observability_get_metric_metadata
Get metric metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metric_name | string | Yes | — | Name of the metric for which to get metadata. |
datadog_observability_list_logs
Search logs (POST) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string | No | — | The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified. |
limit | integer | No | — | Number of logs return in the response. |
query | string | No | — | The search query - following the log search syntax. |
sort | string | No | — | Time-ascending asc or time-descending desc results. |
startAt | string | No | — | Hash identifier of the first log to return in the list, available in a log id attribute. This parameter is used for the pagination feature. Note: This parameter is ignored if the corresponding log is out of the scope of the specified time window. |
time | object | No | — | Timeframe to retrieve the log from. |
datadog_observability_list_metric_assets
Related Assets to a Metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metric_name | string | Yes | — | The name of the metric. |
datadog_observability_list_rumevents
Get a list of RUM events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[query] | string | No | — | Search query following RUM syntax. |
filter[from] | string | No | — | Minimum timestamp for requested events. |
filter[to] | string | No | — | Maximum timestamp for requested events. |
sort | string | No | — | Order of events in results. |
page[cursor] | string | No | — | List following results with a cursor provided in the previous query. |
page[limit] | integer | No | — | Maximum number of events in the response. |
datadog_observability_list_spans
Search spans Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | No | — | The object containing the query content. |
datadog_observability_list_tag_configurations
Get a list of metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[configured] | boolean | No | — | Only return custom metrics that have been configured with Metrics Without Limits. |
filter[tags_configured] | string | No | — | Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded). |
filter[metric_type] | string | No | — | Only return metrics of the given metric type. |
filter[include_percentiles] | boolean | No | — | Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false). |
filter[queried] | boolean | No | — | Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with filter[queried][window][seconds]; if omitted, a default window is used. |
filter[queried][window][seconds] | integer | No | — | Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with filter[queried]. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second. |
filter[tags] | string | No | — | Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*). |
filter[related_assets] | boolean | No | — | Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO. |
window[seconds] | integer | No | — | Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second. |
page[size] | integer | No | — | Maximum number of results per page. Use with page[cursor] for pagination. The default value is 10000, the maximum value is 10000, and the minimum value is 1. |
page[cursor] | string | No | — | Cursor for pagination. Use page[size] to opt-in to pagination and get the first page; for subsequent pages, use the value from meta.pagination.next_cursor in the response. Pagination is complete when next_cursor is null. |
datadog_observability_query_metrics
Query timeseries points Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | integer | Yes | — | Start of the queried time period, seconds since the Unix epoch. |
to | integer | Yes | — | End of the queried time period, seconds since the Unix epoch. |
query | string | Yes | — | Query string. |
datadog_observability_query_scalar_data
Query scalar data across multiple products Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | A single scalar query to be executed. |
datadog_observability_query_timeseries_data
Query timeseries data across multiple products Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | A single timeseries query to be executed. |
datadog_observability_search_rumevents
Search RUM events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | object | No | — | The search and filter query settings. |
options | object | No | — | Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails. |
page | object | No | — | Paging attributes for listing events. |
sort | string | No | — | Sort parameters when querying events. |
datadog_observability_submit_metrics
Submit metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Encoding | string | No | — | HTTP header used to compress the media-type. |
series | object[] | Yes | — | A list of timeseries to submit to Datadog. |
datadog_observability_update_metric_metadata
Edit metric metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metric_name | string | Yes | — | Name of the metric for which to edit metadata. |
description | string | No | — | Metric description. |
integration | string | No | — | Name of the integration that sent the metric if applicable. |
per_unit | string | No | — | Per unit of the metric such as second in bytes per second. |
short_name | string | No | — | A more human-readable and abbreviated version of the metric name. |
statsd_interval | integer | No | — | StatsD flush interval of the metric in seconds if applicable. |
type | string | No | — | Metric type such as gauge or rate. |
unit | string | No | — | Primary unit of the metric such as byte or operation. |

