Skip to main content
Server path: /datadog-observability | Type: Application | PCID required: Yes

Tools


datadog_observability_aggregate_logs

Aggregate events Parameters:
ParameterTypeRequiredDefaultDescription
computeobject[]NoThe list of metrics or timeseries to compute for the retrieved buckets.
filterobjectNoThe search and filter query settings
group_byobject[]NoThe rules for the group by
optionsobjectNoGlobal query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results.
pageobjectNoPaging settings

datadog_observability_aggregate_rumevents

Aggregate RUM events Parameters:
ParameterTypeRequiredDefaultDescription
computeobject[]NoThe list of metrics or timeseries to compute for the retrieved buckets.
filterobjectNoThe search and filter query settings.
group_byobject[]NoThe rules for the group by.
optionsobjectNoGlobal query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
pageobjectNoPaging attributes for listing events.

datadog_observability_aggregate_spans

Aggregate spans Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoThe object containing the query content.

datadog_observability_estimate_metrics_output_series

Tag Configuration Cardinality Estimator Parameters:
ParameterTypeRequiredDefaultDescription
metric_namestringYesThe name of the metric.
filter[groups]stringNoFiltered tag keys that the metric is configured to query with.
filter[hours_ago]integerNoThe number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
filter[num_aggregations]integerNoDeprecated. Number of aggregations has no impact on volume.
filter[pct]booleanNoA boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
filter[timespan_h]integerNoA 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:
ParameterTypeRequiredDefaultDescription
metric_namestringYesName of the metric for which to get metadata.

datadog_observability_list_logs

Search logs (POST) Parameters:
ParameterTypeRequiredDefaultDescription
indexstringNoThe 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.
limitintegerNoNumber of logs return in the response.
querystringNoThe search query - following the log search syntax.
sortstringNoTime-ascending asc or time-descending desc results.
startAtstringNoHash 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.
timeobjectNoTimeframe to retrieve the log from.

datadog_observability_list_metric_assets

Related Assets to a Metric Parameters:
ParameterTypeRequiredDefaultDescription
metric_namestringYesThe name of the metric.

datadog_observability_list_rumevents

Get a list of RUM events Parameters:
ParameterTypeRequiredDefaultDescription
filter[query]stringNoSearch query following RUM syntax.
filter[from]stringNoMinimum timestamp for requested events.
filter[to]stringNoMaximum timestamp for requested events.
sortstringNoOrder of events in results.
page[cursor]stringNoList following results with a cursor provided in the previous query.
page[limit]integerNoMaximum number of events in the response.

datadog_observability_list_spans

Search spans Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoThe object containing the query content.

datadog_observability_list_tag_configurations

Get a list of metrics Parameters:
ParameterTypeRequiredDefaultDescription
filter[configured]booleanNoOnly return custom metrics that have been configured with Metrics Without Limits.
filter[tags_configured]stringNoOnly return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
filter[metric_type]stringNoOnly return metrics of the given metric type.
filter[include_percentiles]booleanNoOnly return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
filter[queried]booleanNoOnly 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]integerNoOnly 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]stringNoOnly 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]booleanNoOnly return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
window[seconds]integerNoOnly 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]integerNoMaximum 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]stringNoCursor 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:
ParameterTypeRequiredDefaultDescription
fromintegerYesStart of the queried time period, seconds since the Unix epoch.
tointegerYesEnd of the queried time period, seconds since the Unix epoch.
querystringYesQuery string.

datadog_observability_query_scalar_data

Query scalar data across multiple products Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesA single scalar query to be executed.

datadog_observability_query_timeseries_data

Query timeseries data across multiple products Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesA single timeseries query to be executed.

datadog_observability_search_rumevents

Search RUM events Parameters:
ParameterTypeRequiredDefaultDescription
filterobjectNoThe search and filter query settings.
optionsobjectNoGlobal query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
pageobjectNoPaging attributes for listing events.
sortstringNoSort parameters when querying events.

datadog_observability_submit_metrics

Submit metrics Parameters:
ParameterTypeRequiredDefaultDescription
Content-EncodingstringNoHTTP header used to compress the media-type.
seriesobject[]YesA list of timeseries to submit to Datadog.

datadog_observability_update_metric_metadata

Edit metric metadata Parameters:
ParameterTypeRequiredDefaultDescription
metric_namestringYesName of the metric for which to edit metadata.
descriptionstringNoMetric description.
integrationstringNoName of the integration that sent the metric if applicable.
per_unitstringNoPer unit of the metric such as second in bytes per second.
short_namestringNoA more human-readable and abbreviated version of the metric name.
statsd_intervalintegerNoStatsD flush interval of the metric in seconds if applicable.
typestringNoMetric type such as gauge or rate.
unitstringNoPrimary unit of the metric such as byte or operation.