Provides a Datadog powerpack resource. This can be used to create and manage Datadog powerpacks.
# Manage Datadog Powerpacks
resource "datadog_organization_settings" "organization" {
name = "foo-organization"
}
resource "datadog_powerpack" "foo" {
description = "Created using the Datadog provider in terraform"
live_span = "4h"
layout {
height = 10
width = 3
x = 1
y = 0
}
template_variables {
defaults = ["defaults"]
name = "datacenter"
}
widget {
event_stream_definition {
query = "*"
event_size = "l"
title = "Widget Title"
title_size = 16
title_align = "right"
}
}
}
description
(String) The description of the powerpack.layout
(Block List, Max: 1) The layout of the powerpack on a free-form dashboard. (see below for nested schema)live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.name
(String) The name for the powerpack.show_title
(Boolean) Whether or not title should be displayed in the powerpack.tags
(Set of String) List of tags to identify this powerpack.template_variables
(Block List) The list of template variables for this powerpack. (see below for nested schema)widget
(Block List) The list of widgets to display in the powerpack. (see below for nested schema)id
(String) The ID of this resource.layout
Optional:
height
(Number) The height of the widget.width
(Number) The width of the widget.x
(Number) The position of the widget on the x (horizontal) axis. Should be greater than or equal to 0.y
(Number) The position of the widget on the y (vertical) axis. Should be greater than or equal to 0.template_variables
Required:
name
(String) The name of the powerpack template variable.Optional:
defaults
(List of String) One or many default values for powerpack template variables on load. If more than one default is specified, they will be unioned together with OR
.widget
Optional:
alert_graph_definition
(Block List, Max: 1) The definition for a Alert Graph widget. (see below for nested schema)alert_value_definition
(Block List, Max: 1) The definition for a Alert Value widget. (see below for nested schema)change_definition
(Block List, Max: 1) The definition for a Change widget. (see below for nested schema)check_status_definition
(Block List, Max: 1) The definition for a Check Status widget. (see below for nested schema)distribution_definition
(Block List, Max: 1) The definition for a Distribution widget. (see below for nested schema)event_stream_definition
(Block List, Max: 1) The definition for a Event Stream widget. (see below for nested schema)event_timeline_definition
(Block List, Max: 1) The definition for a Event Timeline widget. (see below for nested schema)free_text_definition
(Block List, Max: 1) The definition for a Free Text widget. (see below for nested schema)geomap_definition
(Block List, Max: 1) The definition for a Geomap widget. (see below for nested schema)heatmap_definition
(Block List, Max: 1) The definition for a Heatmap widget. (see below for nested schema)hostmap_definition
(Block List, Max: 1) The definition for a Hostmap widget. (see below for nested schema)iframe_definition
(Block List, Max: 1) The definition for an Iframe widget. (see below for nested schema)image_definition
(Block List, Max: 1) The definition for an Image widget (see below for nested schema)list_stream_definition
(Block List, Max: 1) The definition for a List Stream widget. (see below for nested schema)log_stream_definition
(Block List, Max: 1) The definition for an Log Stream widget. (see below for nested schema)manage_status_definition
(Block List, Max: 1) The definition for an Manage Status widget. (see below for nested schema)note_definition
(Block List, Max: 1) The definition for a Note widget. (see below for nested schema)query_table_definition
(Block List, Max: 1) The definition for a Query Table widget. (see below for nested schema)query_value_definition
(Block List, Max: 1) The definition for a Query Value widget. (see below for nested schema)run_workflow_definition
(Block List, Max: 1) The definition for a Run Workflow widget. (see below for nested schema)scatterplot_definition
(Block List, Max: 1) The definition for a Scatterplot widget. (see below for nested schema)service_level_objective_definition
(Block List, Max: 1) The definition for a Service Level Objective widget. (see below for nested schema)servicemap_definition
(Block List, Max: 1) The definition for a Service Map widget. (see below for nested schema)slo_list_definition
(Block List, Max: 1) The definition for an SLO (Service Level Objective) List widget. (see below for nested schema)sunburst_definition
(Block List, Max: 1) The definition for a Sunburst widget. (see below for nested schema)timeseries_definition
(Block List, Max: 1) The definition for a Timeseries widget. (see below for nested schema)toplist_definition
(Block List, Max: 1) The definition for a Toplist widget. (see below for nested schema)topology_map_definition
(Block List, Max: 1) The definition for a Topology Map widget. (see below for nested schema)trace_service_definition
(Block List, Max: 1) The definition for a Trace Service widget. (see below for nested schema)treemap_definition
(Block List, Max: 1) The definition for a Treemap widget. (see below for nested schema)widget_layout
(Block List, Max: 1) The layout of the widget on a 'free' dashboard. (see below for nested schema)Read-Only:
id
(Number) The ID of the widget.widget.alert_graph_definition
Required:
alert_id
(String) The ID of the monitor used by the widget.viz_type
(String) Type of visualization to use when displaying the widget. Valid values are timeseries
, toplist
.Optional:
live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.alert_value_definition
Required:
alert_id
(String) The ID of the monitor used by the widget.Optional:
precision
(Number) The precision to use when displaying the value. Use *
for maximum precision.text_align
(String) The alignment of the text in the widget. Valid values are center
, left
, right
.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).unit
(String) The unit for the value displayed in the widget.widget.change_definition
Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request blocks are allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
or process_query
is required within the request block). (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.change_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.change_definition.request
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)change_type
(String) Whether to show absolute or relative change. Valid values are absolute
, relative
.compare_to
(String) Choose from when to compare current data to. Valid values are hour_before
, day_before
, week_before
, month_before
.formula
(Block List) (see below for nested schema)increase_good
(Boolean) A Boolean indicating whether an increase in the value is good (displayed in green) or not (displayed in red).log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)order_by
(String) What to order by. Valid values are change
, name
, present
, past
.order_dir
(String) Widget sorting method. Valid values are asc
, desc
.process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)show_present
(Boolean) If set to true
, displays the current value.widget.change_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.change_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.change_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.change_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.change_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.change_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.change_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.change_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.change_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.change_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.change_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.change_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.change_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.change_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.change_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.change_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.change_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.change_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.change_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.change_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.change_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.change_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.change_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.change_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.change_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.change_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.change_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.change_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.change_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.change_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.change_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.change_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.change_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.change_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.change_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.change_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.change_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.check_status_definition
Required:
check
(String) The check to use in the widget.grouping
(String) The kind of grouping to use. Valid values are check
, cluster
.Optional:
group
(String) The check group to use in the widget.group_by
(List of String) When grouping = "cluster"
, indicates a list of tags to use for grouping.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.tags
(List of String) A list of tags to use in the widget.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.distribution_definition
Optional:
legend_size
(String) The size of the legend displayed in the widget.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request blocks are allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
or process_query
is required within the request block). (see below for nested schema)show_legend
(Boolean) Whether or not to show the legend on this widget.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.distribution_definition.request
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)apm_stats_query
(Block List, Max: 1) (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)style
(Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see below for nested schema)widget.distribution_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.distribution_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.distribution_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.distribution_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.apm_stats_query
Required:
env
(String) The environment name.name
(String) The operation name associated with the service.primary_tag
(String) The organization's host group name and value.row_type
(String) The level of detail for the request. Valid values are service
, resource
, span
.service
(String) The service name.Optional:
columns
(Block List) Column properties used by the front end for display. (see below for nested schema)resource
(String) The resource name.widget.distribution_definition.request.apm_stats_query.columns
Required:
name
(String) The column name.Optional:
alias
(String) A user-assigned alias for the column.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.order
(String) Widget sorting methods. Valid values are asc
, desc
.widget.distribution_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.distribution_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.distribution_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.distribution_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.distribution_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.distribution_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.distribution_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.distribution_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.distribution_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.distribution_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.distribution_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.distribution_definition.request.style
Optional:
palette
(String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance.widget.event_stream_definition
Required:
query
(String) The query to use in the widget.Optional:
event_size
(String) The size to use to display an event. Valid values are s
, l
.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.tags_execution
(String) The execution method for multi-value filters, options: and
or or
.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.event_timeline_definition
Required:
query
(String) The query to use in the widget.Optional:
live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.tags_execution
(String) The execution method for multi-value filters, options: and
or or
.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.free_text_definition
Required:
text
(String) The text to display in the widget.Optional:
color
(String) The color of the text in the widget.font_size
(String) The size of the text in the widget.text_align
(String) The alignment of the text in the widget. Valid values are center
, left
, right
.widget.geomap_definition
Required:
view
(Block List, Min: 1, Max: 1) The view of the world that the map should render. (see below for nested schema)Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed using the structure below (exactly one of q
, log_query
or rum_query
is required within the request
block). (see below for nested schema)style
(Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.geomap_definition.view
Required:
focus
(String) The two-letter ISO code of a country to focus the map on (or WORLD
).widget.geomap_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.geomap_definition.request
Optional:
formula
(Block List) (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)widget.geomap_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.geomap_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.geomap_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.geomap_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.geomap_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.geomap_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.geomap_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.geomap_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.geomap_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.geomap_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.geomap_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.geomap_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.geomap_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.geomap_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.geomap_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.geomap_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.geomap_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.geomap_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.geomap_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.geomap_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.geomap_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.geomap_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.geomap_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.geomap_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.geomap_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.geomap_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.geomap_definition.style
Required:
palette
(String) The color palette to apply to the widget.palette_flip
(Boolean) A Boolean indicating whether to flip the palette tones.widget.heatmap_definition
Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)event
(Block List) The definition of the event to overlay on the graph. Multiple event
blocks are allowed using the structure below. (see below for nested schema)legend_size
(String) The size of the legend displayed in the widget.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
or process_query
is required within the request block). (see below for nested schema)show_legend
(Boolean) Whether or not to show the legend on this widget.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).yaxis
(Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below. (see below for nested schema)widget.heatmap_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.heatmap_definition.event
Required:
q
(String) The event query to use in the widget.Optional:
tags_execution
(String) The execution method for multi-value filters.widget.heatmap_definition.request
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)formula
(Block List) (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)style
(Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see below for nested schema)widget.heatmap_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.heatmap_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.heatmap_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.heatmap_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.heatmap_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.heatmap_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.heatmap_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.heatmap_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.heatmap_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.heatmap_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.heatmap_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.heatmap_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.heatmap_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.heatmap_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.heatmap_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.heatmap_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.heatmap_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.heatmap_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.heatmap_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.heatmap_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.heatmap_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.heatmap_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.heatmap_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.heatmap_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.heatmap_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.heatmap_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.heatmap_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.heatmap_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.heatmap_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.heatmap_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.heatmap_definition.request.style
Optional:
palette
(String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance.widget.heatmap_definition.yaxis
Optional:
include_zero
(Boolean) Always include zero or fit the axis to the data range.label
(String) The label of the axis to display on the graph.max
(String) Specify the maximum value to show on the Y-axis.min
(String) Specify the minimum value to show on the Y-axis.scale
(String) Specify the scale type, options: linear
, log
, pow
, sqrt
.widget.hostmap_definition
Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)group
(List of String) The list of tags to group nodes by.no_group_hosts
(Boolean) A Boolean indicating whether to show ungrouped nodes.no_metric_hosts
(Boolean) A Boolean indicating whether to show nodes with no metrics.node_type
(String) The type of node used. Valid values are host
, container
.request
(Block List, Max: 1) A nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed using the structure below. (see below for nested schema)scope
(List of String) The list of tags to filter nodes by.style
(Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.hostmap_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.hostmap_definition.request
Optional:
fill
(Block List) The query used to fill the map. Exactly one nested block is allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
or process_query
is required within the request block). (see below for nested schema)size
(Block List) The query used to size the map. Exactly one nested block is allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
or process_query
is required within the request block). (see below for nested schema)widget.hostmap_definition.request.fill
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)widget.hostmap_definition.request.fill.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.fill.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.fill.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.fill.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.fill.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.fill.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.fill.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.fill.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.fill.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.fill.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.fill.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.hostmap_definition.request.fill.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.fill.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.fill.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.fill.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.fill.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.fill.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.fill.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.fill.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.fill.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.fill.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)widget.hostmap_definition.request.size.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.size.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.size.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.size.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.size.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.size.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.size.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.hostmap_definition.request.size.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.size.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.size.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.size.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.hostmap_definition.request.size.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.request.size.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.hostmap_definition.request.size.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.hostmap_definition.request.size.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.hostmap_definition.style
Optional:
fill_max
(String) The max value to use to color the map.fill_min
(String) The min value to use to color the map.palette
(String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance.palette_flip
(Boolean) A Boolean indicating whether to flip the palette tones.widget.iframe_definition
Required:
url
(String) The URL to use as a data source for the widget.widget.image_definition
Required:
url
(String) The URL to use as a data source for the widget.Optional:
has_background
(Boolean) Whether to display a background or not. Defaults to true
.has_border
(Boolean) Whether to display a border or not. Defaults to true
.horizontal_align
(String) The horizontal alignment for the widget. Valid values are center
, left
, right
.margin
(String) The margins to use around the image. Note: small
and large
values are deprecated. Valid values are sm
, md
, lg
, small
, large
.sizing
(String) The preferred method to adapt the dimensions of the image. The values are based on the image object-fit
CSS properties. Note: zoom
, fit
and center
values are deprecated. Valid values are fill
, contain
, cover
, none
, scale-down
, zoom
, fit
, center
.url_dark_theme
(String) The URL in dark mode to use as a data source for the widget.vertical_align
(String) The vertical alignment for the widget. Valid values are center
, top
, bottom
.widget.list_stream_definition
Required:
request
(Block List, Min: 1) Nested block describing the requests to use when displaying the widget. Multiple request
blocks are allowed with the structure below. (see below for nested schema)Optional:
title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title. Default is 16.widget.list_stream_definition.request
Required:
columns
(Block List, Min: 1) Widget columns. (see below for nested schema)query
(Block List, Min: 1, Max: 1) Updated list stream widget. (see below for nested schema)response_format
(String) Widget response format. Valid values are event_list
.widget.list_stream_definition.request.columns
Required:
field
(String) Widget column field.width
(String) Widget column width. Valid values are auto
, compact
, full
.widget.list_stream_definition.request.query
Required:
data_source
(String) Source from which to query items to display in the stream. Valid values are logs_stream
, audit_stream
, ci_pipeline_stream
, ci_test_stream
, rum_issue_stream
, apm_issue_stream
, trace_stream
, logs_issue_stream
, logs_pattern_stream
, logs_transaction_stream
, event_stream
.Optional:
event_size
(String) Size of events displayed in widget. Required if data_source
is event_stream
. Valid values are s
, l
.indexes
(List of String) List of indexes.query_string
(String) Widget query.sort
(Block List, Max: 1) The facet and order to sort the data, for example: {"column": "time", "order": "desc"}
. (see below for nested schema)storage
(String) Storage location (private beta).widget.list_stream_definition.request.query.sort
Required:
column
(String) The facet path for the column.order
(String) Widget sorting methods. Valid values are asc
, desc
.widget.log_stream_definition
Optional:
columns
(List of String) Stringified list of columns to use, for example: ["column1","column2","column3"]
.indexes
(List of String) An array of index names to query in the stream.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.message_display
(String) The number of log lines to display. Valid values are inline
, expanded-md
, expanded-lg
.query
(String) The query to use in the widget.show_date_column
(Boolean) If the date column should be displayed.show_message_column
(Boolean) If the message column should be displayed.sort
(Block List, Max: 1) The facet and order to sort the data, for example: {"column": "time", "order": "desc"}
. (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.log_stream_definition.sort
Required:
column
(String) The facet path for the column.order
(String) Widget sorting methods. Valid values are asc
, desc
.widget.manage_status_definition
Required:
query
(String) The query to use in the widget.Optional:
color_preference
(String) Whether to colorize text or background. Valid values are background
, text
.display_format
(String) The display setting to use. Valid values are counts
, countsAndList
, list
.hide_zero_counts
(Boolean) A Boolean indicating whether to hide empty categories.show_last_triggered
(Boolean) A Boolean indicating whether to show when monitors/groups last triggered.show_priority
(Boolean) Whether to show the priorities column.sort
(String) The method to sort the monitors. Valid values are name
, group
, status
, tags
, triggered
, group,asc
, group,desc
, name,asc
, name,desc
, status,asc
, status,desc
, tags,asc
, tags,desc
, triggered,asc
, triggered,desc
, priority,asc
, priority,desc
.summary_type
(String) The summary type to use. Valid values are monitors
, groups
, combined
.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.note_definition
Required:
content
(String) The content of the note.Optional:
background_color
(String) The background color of the note.font_size
(String) The size of the text.has_padding
(Boolean) Whether to add padding or not. Defaults to true
.show_tick
(Boolean) Whether to show a tick or not.text_align
(String) The alignment of the widget's text. Valid values are center
, left
, right
.tick_edge
(String) When tick = true
, a string indicating on which side of the widget the tick should be displayed. Valid values are bottom
, left
, right
, top
.tick_pos
(String) When tick = true
, a string with a percent sign indicating the position of the tick, for example: tick_pos = "50%"
is centered alignment.vertical_align
(String) The vertical alignment for the widget. Valid values are center
, top
, bottom
.widget.query_table_definition
Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)has_search_bar
(String) Controls the display of the search bar. Valid values are always
, never
, auto
.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
, apm_stats_query
or process_query
is required within the request
block). (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.query_table_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.query_table_definition.request
Optional:
aggregator
(String) The aggregator to use for time aggregation. Valid values are avg
, last
, max
, min
, sum
, percentile
.alias
(String) The alias for the column name (defaults to metric name).apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)apm_stats_query
(Block List, Max: 1) (see below for nested schema)cell_display_mode
(List of String) A list of display modes for each table cell. List items one of number
, bar
. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background, depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)formula
(Block List) (see below for nested schema)limit
(Number) The number of lines to show in the table.log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)order
(String) The sort order for the rows. Valid values are asc
, desc
.process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)widget.query_table_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_table_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_table_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_table_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_table_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_table_definition.request.apm_stats_query
Required:
env
(String) The environment name.name
(String) The operation name associated with the service.primary_tag
(String) The organization's host group name and value.row_type
(String) The level of detail for the request. Valid values are service
, resource
, span
.service
(String) The service name.Optional:
columns
(Block List) Column properties used by the front end for display. (see below for nested schema)resource
(String) The resource name.widget.query_table_definition.request.apm_stats_query.columns
Required:
name
(String) The column name.Optional:
alias
(String) A user-assigned alias for the column.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.order
(String) Widget sorting methods. Valid values are asc
, desc
.widget.query_table_definition.request.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.query_table_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.query_table_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.query_table_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.query_table_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.query_table_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_table_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_table_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_table_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_table_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_table_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.query_table_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.query_table_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.query_table_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.query_table_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.query_table_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.query_table_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.query_table_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.query_table_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.query_table_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.query_table_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.query_table_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.query_table_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.query_table_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_table_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_table_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_table_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_table_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_table_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_table_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_table_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_table_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_table_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition
Optional:
autoscale
(Boolean) A Boolean indicating whether to automatically scale the tile.custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)custom_unit
(String) The unit for the value displayed in the widget.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.precision
(Number) The precision to use when displaying the tile.request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
or process_query
is required within the request
block). (see below for nested schema)text_align
(String) The alignment of the widget's text. Valid values are center
, left
, right
.timeseries_background
(Block List, Max: 1) Set a timeseries on the widget background. (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.query_value_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.query_value_definition.request
Optional:
aggregator
(String) The aggregator to use for time aggregation. Valid values are avg
, last
, max
, min
, sum
, percentile
.apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)audit_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)formula
(Block List) (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)widget.query_value_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_value_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_value_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_value_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.audit_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_value_definition.request.audit_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.audit_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_value_definition.request.audit_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_value_definition.request.audit_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.query_value_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.query_value_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.query_value_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.query_value_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.query_value_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_value_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_value_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_value_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.query_value_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.query_value_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.query_value_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.query_value_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.query_value_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.query_value_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.query_value_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.query_value_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.query_value_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.query_value_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.query_value_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.query_value_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.query_value_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_value_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_value_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_value_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.query_value_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.query_value_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.query_value_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.query_value_definition.timeseries_background
Required:
type
(String) Whether the Timeseries is made using an area or bars. Valid values are bars
, area
.Optional:
yaxis
(Block List, Max: 1) A nested block describing the Y-Axis Controls. Exactly one nested block is allowed using the structure below. (see below for nested schema)widget.query_value_definition.timeseries_background.yaxis
Optional:
include_zero
(Boolean) Always include zero or fit the axis to the data range.label
(String) The label of the axis to display on the graph.max
(String) Specify the maximum value to show on the Y-axis.min
(String) Specify the minimum value to show on the Y-axis.scale
(String) Specify the scale type, options: linear
, log
, pow
, sqrt
.widget.run_workflow_definition
Required:
workflow_id
(String) Workflow IDOptional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)input
(Block List) Array of workflow inputs to map to dashboard template variables. (see below for nested schema)live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.run_workflow_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.run_workflow_definition.input
Required:
name
(String) Name of the workflow input.value
(String) Dashboard template variable. Can be suffixed with .value
or .key
.widget.scatterplot_definition
Optional:
color_by_groups
(List of String) List of groups used for colors.custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List, Max: 1) A nested block describing the request to use when displaying the widget. Exactly one request
block is allowed using the structure below. (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).xaxis
(Block List, Max: 1) A nested block describing the X-Axis Controls. Exactly one nested block is allowed using the structure below. (see below for nested schema)yaxis
(Block List, Max: 1) A nested block describing the Y-Axis Controls. Exactly one nested block is allowed using the structure below. (see below for nested schema)widget.scatterplot_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.scatterplot_definition.request
Optional:
scatterplot_table
(Block List) Scatterplot request containing formulas and functions. (see below for nested schema)x
(Block List) The query used for the X-Axis. Exactly one nested block is allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
, apm_stats_query
or process_query
is required within the block). (see below for nested schema)y
(Block List) The query used for the Y-Axis. Exactly one nested block is allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
, apm_stats_query
or process_query
is required within the block). (see below for nested schema)widget.scatterplot_definition.request.scatterplot_table
Optional:
formula
(Block List) (see below for nested schema)query
(Block List) (see below for nested schema)widget.scatterplot_definition.request.scatterplot_table.formula
Required:
dimension
(String) Dimension of the Scatterplot. Valid values are x
, y
, radius
, color
.formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.widget.scatterplot_definition.request.scatterplot_table.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.scatterplot_definition.request.scatterplot_table.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.scatterplot_definition.request.scatterplot_table.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.scatterplot_definition.request.scatterplot_table.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.scatterplot_definition.request.scatterplot_table.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.scatterplot_definition.request.scatterplot_table.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.scatterplot_definition.request.scatterplot_table.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.scatterplot_definition.request.scatterplot_table.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.scatterplot_definition.request.scatterplot_table.query.event_query.search
Required:
query
(String) The events search string.widget.scatterplot_definition.request.scatterplot_table.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.scatterplot_definition.request.scatterplot_table.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.scatterplot_definition.request.scatterplot_table.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.scatterplot_definition.request.x
Optional:
aggregator
(String) Aggregator used for the request. Valid values are avg
, last
, max
, min
, sum
, percentile
.apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)widget.scatterplot_definition.request.x.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.x.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.x.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.x.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.x.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.x.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.x.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.x.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.x.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.x.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.x.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.scatterplot_definition.request.x.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.x.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.x.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.x.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.x.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.x.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.x.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.x.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.x.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.x.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y
Optional:
aggregator
(String) Aggregator used for the request. Valid values are avg
, last
, max
, min
, sum
, percentile
.apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)widget.scatterplot_definition.request.y.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.y.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.y.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.y.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.y.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.y.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.y.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.scatterplot_definition.request.y.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.y.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.y.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.y.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.scatterplot_definition.request.y.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.request.y.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.scatterplot_definition.request.y.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.scatterplot_definition.request.y.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.scatterplot_definition.xaxis
Optional:
include_zero
(Boolean) Always include zero or fit the axis to the data range.label
(String) The label of the axis to display on the graph.max
(String) Specify the maximum value to show on the Y-axis.min
(String) Specify the minimum value to show on the Y-axis.scale
(String) Specify the scale type, options: linear
, log
, pow
, sqrt
.widget.scatterplot_definition.yaxis
Optional:
include_zero
(Boolean) Always include zero or fit the axis to the data range.label
(String) The label of the axis to display on the graph.max
(String) Specify the maximum value to show on the Y-axis.min
(String) Specify the minimum value to show on the Y-axis.scale
(String) Specify the scale type, options: linear
, log
, pow
, sqrt
.widget.service_level_objective_definition
Required:
slo_id
(String) The ID of the service level objective used by the widget.time_windows
(List of String) A list of time windows to display in the widget. Valid values are 7d
, 30d
, 90d
, week_to_date
, previous_week
, month_to_date
, previous_month
, global_time
.view_mode
(String) The view mode for the widget. Valid values are overall
, component
, both
.view_type
(String) The type of view to use when displaying the widget. Only detail
is supported.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.global_time_target
(String) The global time target of the widget.show_error_budget
(Boolean) Whether to show the error budget or not.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.servicemap_definition
Required:
filters
(List of String) Your environment and primary tag (or *
if enabled for your account).service
(String) The ID of the service to map.Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.servicemap_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.slo_list_definition
Required:
request
(Block List, Min: 1, Max: 1) A nested block describing the request to use when displaying the widget. Exactly one request
block is allowed. (see below for nested schema)Optional:
title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.slo_list_definition.request
Required:
query
(Block List, Min: 1, Max: 1) Updated SLO List widget. (see below for nested schema)request_type
(String) The request type for the SLO List request. Valid values are slo_list
.widget.slo_list_definition.request.query
Required:
query_string
(String) Widget query.Optional:
limit
(Number) Maximum number of results to display in the table. Defaults to 100
.sort
(Block List, Max: 1) The facet and order to sort the data, for example: {"column": "status.sli", "order": "desc"}
. (see below for nested schema)widget.slo_list_definition.request.query.sort
Required:
column
(String) The facet path for the column.order
(String) Widget sorting methods. Valid values are asc
, desc
.widget.sunburst_definition
Optional:
custom_link
(Block List) Nested block describing a custom link. Multiple custom_link
blocks are allowed with the structure below. (see below for nested schema)hide_total
(Boolean) Whether or not to show the total value in the widget.legend_inline
(Block List, Max: 1) Used to configure the inline legend. Cannot be used in conjunction with legend_table. (see below for nested schema)legend_table
(Block List, Max: 1) Used to configure the table legend. Cannot be used in conjunction with legend_inline. (see below for nested schema)live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List) Nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed with the structure below (exactly one of q
, log_query
or rum_query
is required within the request
block). (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. One of left
, center
, or right
. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title. Default is 16.widget.sunburst_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.sunburst_definition.legend_inline
Required:
type
(String) The type of legend (inline or automatic). Valid values are inline
, automatic
.Optional:
hide_percent
(Boolean) Whether to hide the percentages of the groups.hide_value
(Boolean) Whether to hide the values of the groups.widget.sunburst_definition.legend_table
Required:
type
(String) The type of legend (table or none). Valid values are table
, none
.widget.sunburst_definition.request
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)audit_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)formula
(Block List) (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)network_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)style
(Block List, Max: 1) Define style for the widget's request. (see below for nested schema)widget.sunburst_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.sunburst_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.sunburst_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.sunburst_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.audit_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.sunburst_definition.request.audit_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.audit_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.sunburst_definition.request.audit_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.sunburst_definition.request.audit_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.sunburst_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.sunburst_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.sunburst_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.sunburst_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.sunburst_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.sunburst_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.sunburst_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.network_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.sunburst_definition.request.network_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.network_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.sunburst_definition.request.network_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.sunburst_definition.request.network_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.sunburst_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.sunburst_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.sunburst_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.sunburst_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.sunburst_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.sunburst_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.sunburst_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.sunburst_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.sunburst_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.sunburst_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.sunburst_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.sunburst_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.sunburst_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.sunburst_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.sunburst_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.sunburst_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.sunburst_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.sunburst_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.sunburst_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.sunburst_definition.request.style
Optional:
palette
(String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance.widget.timeseries_definition
Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)event
(Block List) The definition of the event to overlay on the graph. Multiple event
blocks are allowed using the structure below. (see below for nested schema)legend_columns
(Set of String) A list of columns to display in the legend. Valid values are value
, avg
, sum
, min
, max
.legend_layout
(String) The layout of the legend displayed in the widget. Valid values are auto
, horizontal
, vertical
.legend_size
(String) The size of the legend displayed in the widget.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.marker
(Block List) A nested block describing the marker to use when displaying the widget. The structure of this block is described below. Multiple marker
blocks are allowed within a given tile_def
block. (see below for nested schema)request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, network_query
, security_query
or process_query
is required within the request
block). (see below for nested schema)right_yaxis
(Block List, Max: 1) A nested block describing the right Y-Axis Controls. See the on_right_yaxis
property for which request will use this axis. The structure of this block is described below. (see below for nested schema)show_legend
(Boolean) Whether or not to show the legend on this widget.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).yaxis
(Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below. (see below for nested schema)widget.timeseries_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.timeseries_definition.event
Required:
q
(String) The event query to use in the widget.Optional:
tags_execution
(String) The execution method for multi-value filters.widget.timeseries_definition.marker
Required:
value
(String) A mathematical expression describing the marker, for example: y > 1
, -5 < y < 0
, y = 19
.Optional:
display_type
(String) How the marker lines are displayed, options are one of {error
, warning
, info
, ok
} combined with one of {dashed
, solid
, bold
}. Example: error dashed
.label
(String) A label for the line or range.widget.timeseries_definition.request
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)audit_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)display_type
(String) How to display the marker lines. Valid values are area
, bars
, line
, overlay
.formula
(Block List) (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)metadata
(Block List) Used to define expression aliases. Multiple metadata
blocks are allowed using the structure below. (see below for nested schema)network_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)on_right_yaxis
(Boolean) A Boolean indicating whether the request uses the right or left Y-Axis.process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)style
(Block List, Max: 1) The style of the widget graph. Exactly one style
block is allowed using the structure below. (see below for nested schema)widget.timeseries_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.timeseries_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.timeseries_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.timeseries_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.audit_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.timeseries_definition.request.audit_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.audit_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.timeseries_definition.request.audit_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.timeseries_definition.request.audit_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.timeseries_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.timeseries_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.timeseries_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.timeseries_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.timeseries_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.timeseries_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.timeseries_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.metadata
Required:
expression
(String) The expression name.Optional:
alias_name
(String) The expression alias.widget.timeseries_definition.request.network_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.timeseries_definition.request.network_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.network_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.timeseries_definition.request.network_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.timeseries_definition.request.network_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.timeseries_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.timeseries_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.timeseries_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.timeseries_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.timeseries_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.timeseries_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.timeseries_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.timeseries_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.timeseries_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.timeseries_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.timeseries_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.timeseries_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.timeseries_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.timeseries_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.timeseries_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.timeseries_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.timeseries_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.timeseries_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.timeseries_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.timeseries_definition.request.style
Optional:
line_type
(String) The type of lines displayed. Valid values are dashed
, dotted
, solid
.line_width
(String) The width of line displayed. Valid values are normal
, thick
, thin
.palette
(String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance.widget.timeseries_definition.right_yaxis
Optional:
include_zero
(Boolean) Always include zero or fit the axis to the data range.label
(String) The label of the axis to display on the graph.max
(String) Specify the maximum value to show on the Y-axis.min
(String) Specify the minimum value to show on the Y-axis.scale
(String) Specify the scale type, options: linear
, log
, pow
, sqrt
.widget.timeseries_definition.yaxis
Optional:
include_zero
(Boolean) Always include zero or fit the axis to the data range.label
(String) The label of the axis to display on the graph.max
(String) Specify the maximum value to show on the Y-axis.min
(String) Specify the minimum value to show on the Y-axis.scale
(String) Specify the scale type, options: linear
, log
, pow
, sqrt
.widget.toplist_definition
Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request
blocks are allowed using the structure below (exactly one of q
, apm_query
, log_query
, rum_query
, security_query
or process_query
is required within the request
block). (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.toplist_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.toplist_definition.request
Optional:
apm_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)audit_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background, depending on a rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)formula
(Block List) (see below for nested schema)log_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)process_query
(Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see below for nested schema)q
(String) The metric query to use for this widget.query
(Block List) (see below for nested schema)rum_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)security_query
(Block List, Max: 1) The query to use for this widget. (see below for nested schema)style
(Block List, Max: 1) Define request for the widget's style. (see below for nested schema)widget.toplist_definition.request.apm_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.toplist_definition.request.apm_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.apm_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.toplist_definition.request.apm_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.toplist_definition.request.apm_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.audit_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.toplist_definition.request.audit_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.audit_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.toplist_definition.request.audit_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.toplist_definition.request.audit_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.toplist_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.toplist_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.toplist_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.toplist_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.toplist_definition.request.log_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.toplist_definition.request.log_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.log_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.toplist_definition.request.log_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.toplist_definition.request.log_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.process_query
Required:
metric
(String) Your chosen metric.Optional:
filter_by
(List of String) A list of processes.limit
(Number) The max number of items in the filter list.search_by
(String) Your chosen search term.widget.toplist_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.toplist_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.toplist_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.toplist_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.toplist_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.toplist_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.toplist_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.toplist_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.toplist_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.toplist_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.toplist_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.toplist_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.toplist_definition.request.rum_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.toplist_definition.request.rum_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.rum_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.toplist_definition.request.rum_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.toplist_definition.request.rum_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.security_query
Required:
index
(String) The name of the index to query.Optional:
compute_query
(Block List, Max: 1) compute_query
or multi_compute
is required. The map keys are listed below. (see below for nested schema)group_by
(Block List) Multiple group_by
blocks are allowed using the structure below. (see below for nested schema)multi_compute
(Block List) compute_query
or multi_compute
is required. Multiple multi_compute
blocks are allowed using the structure below. (see below for nested schema)search_query
(String) The search query to use.widget.toplist_definition.request.security_query.compute_query
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.security_query.group_by
Optional:
facet
(String) The facet name.limit
(Number) The maximum number of items in the group.sort_query
(Block List, Max: 1) A list of exactly one element describing the sort query to use. (see below for nested schema)widget.toplist_definition.request.security_query.group_by.sort_query
Required:
aggregation
(String) The aggregation method.order
(String) Widget sorting methods. Valid values are asc
, desc
.Optional:
facet
(String) The facet name.widget.toplist_definition.request.security_query.multi_compute
Required:
aggregation
(String) The aggregation method.Optional:
facet
(String) The facet name.interval
(Number) Define the time interval in seconds.widget.toplist_definition.request.style
Optional:
palette
(String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance.widget.topology_map_definition
Optional:
custom_link
(Block List) A nested block describing a custom link. Multiple custom_link
blocks are allowed using the structure below. (see below for nested schema)request
(Block List) A nested block describing the request to use when displaying the widget. Multiple request blocks are allowed using the structure below (query
and request_type
are required within the request). (see below for nested schema)title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.topology_map_definition.custom_link
Optional:
is_hidden
(Boolean) The flag for toggling context menu link visibility.label
(String) The label for the custom link URL.link
(String) The URL of the custom link.override_label
(String) The label ID that refers to a context menu link item. When override_label
is provided, the client request omits the label field.widget.topology_map_definition.request
Required:
query
(Block List, Min: 1) The query for a Topology request. (see below for nested schema)request_type
(String) The request type for the Topology request ('topology'). Valid values are topology
.widget.topology_map_definition.request.query
Required:
data_source
(String) The data source for the Topology request ('service_map' or 'data_streams'). Valid values are data_streams
, service_map
.filters
(List of String) Your environment and primary tag (or *
if enabled for your account).service
(String) The ID of the service to map.widget.trace_service_definition
Required:
env
(String) APM environment.service
(String) APM service.span_name
(String) APM span nameOptional:
display_format
(String) The number of columns to display. Valid values are one_column
, two_column
, three_column
.live_span
(String) The timeframe to use when displaying the widget. Valid values are 1m
, 5m
, 10m
, 15m
, 30m
, 1h
, 4h
, 1d
, 2d
, 1w
, 1mo
, 3mo
, 6mo
, week_to_date
, month_to_date
, 1y
, alert
.show_breakdown
(Boolean) Whether to show the latency breakdown or not.show_distribution
(Boolean) Whether to show the latency distribution or not.show_errors
(Boolean) Whether to show the error metrics or not.show_hits
(Boolean) Whether to show the hits metrics or notshow_latency
(Boolean) Whether to show the latency metrics or not.show_resource_list
(Boolean) Whether to show the resource list or not.size_format
(String) The size of the widget. Valid values are small
, medium
, large
.title
(String) The title of the widget.title_align
(String) The alignment of the widget's title. Valid values are center
, left
, right
.title_size
(String) The size of the widget's title (defaults to 16).widget.treemap_definition
Optional:
request
(Block List) Nested block describing the request to use when displaying the widget. (see below for nested schema)title
(String) The title of the widget.widget.treemap_definition.request
Optional:
formula
(Block List) (see below for nested schema)query
(Block List) (see below for nested schema)widget.treemap_definition.request.formula
Required:
formula_expression
(String) A string expression built from queries, formulas, and functions.Optional:
alias
(String) An expression alias.cell_display_mode
(String) A list of display modes for each table cell. Valid values are number
, bar
.conditional_formats
(Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple conditional_formats
blocks are allowed using the structure below. (see below for nested schema)limit
(Block List, Max: 1) The options for limiting results returned. (see below for nested schema)style
(Block List, Max: 1) Styling options for widget formulas. (see below for nested schema)widget.treemap_definition.request.formula.conditional_formats
Required:
comparator
(String) The comparator to use. Valid values are =
, >
, >=
, <
, <=
.palette
(String) The color palette to apply. Valid values are blue
, custom_bg
, custom_image
, custom_text
, gray_on_white
, grey
, green
, orange
, red
, red_on_white
, white_on_gray
, white_on_green
, green_on_white
, white_on_red
, white_on_yellow
, yellow_on_white
, black_on_light_yellow
, black_on_light_green
, black_on_light_red
.value
(Number) A value for the comparator.Optional:
custom_bg_color
(String) The color palette to apply to the background, same values available as palette.custom_fg_color
(String) The color palette to apply to the foreground, same values available as palette.hide_value
(Boolean) Setting this to True hides values.image_url
(String) Displays an image as the background.metric
(String) The metric from the request to correlate with this conditional format.timeframe
(String) Defines the displayed timeframe.widget.treemap_definition.request.formula.limit
Optional:
count
(Number) The number of results to return.order
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.widget.treemap_definition.request.formula.style
Optional:
palette
(String) The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors.palette_index
(Number) Index specifying which color to use within the palette.widget.treemap_definition.request.query
Optional:
apm_dependency_stats_query
(Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see below for nested schema)apm_resource_stats_query
(Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see below for nested schema)cloud_cost_query
(Block List, Max: 1) The Cloud Cost query using formulas and functions. (see below for nested schema)event_query
(Block List, Max: 1) A timeseries formula and functions events query. (see below for nested schema)metric_query
(Block List, Max: 1) A timeseries formula and functions metrics query. (see below for nested schema)process_query
(Block List, Max: 1) The process query using formulas and functions. (see below for nested schema)slo_query
(Block List, Max: 1) The SLO query using formulas and functions. (see below for nested schema)widget.treemap_definition.request.query.apm_dependency_stats_query
Required:
data_source
(String) The data source for APM Dependency Stats queries. Valid values are apm_dependency_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.operation_name
(String) Name of operation on service.resource_name
(String) APM resource.service
(String) APM service.stat
(String) APM statistic. Valid values are avg_duration
, avg_root_duration
, avg_spans_per_trace
, error_rate
, pct_exec_time
, pct_of_traces
, total_traces_count
.Optional:
is_upstream
(Boolean) Determines whether stats for upstream or downstream dependencies should be queried.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.widget.treemap_definition.request.query.apm_resource_stats_query
Required:
data_source
(String) The data source for APM Resource Stats queries. Valid values are apm_resource_stats
.env
(String) APM environment.name
(String) The name of query for use in formulas.service
(String) APM service.stat
(String) APM statistic. Valid values are errors
, error_rate
, hits
, latency_avg
, latency_distribution
, latency_max
, latency_p50
, latency_p75
, latency_p90
, latency_p95
, latency_p99
.Optional:
group_by
(List of String) Array of fields to group results by.operation_name
(String) Name of operation on service.primary_tag_name
(String) The name of the second primary tag used within APM; required when primary_tag_value
is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.primary_tag_value
(String) Filter APM data by the second primary tag. primary_tag_name
must also be specified.resource_name
(String) APM resource.widget.treemap_definition.request.query.cloud_cost_query
Required:
data_source
(String) The data source for cloud cost queries. Valid values are cloud_cost
.name
(String) The name of the query for use in formulas.query
(String) The cloud cost query definition.Optional:
aggregator
(String) The aggregation methods available for cloud cost queries. Valid values are avg
, last
, max
, min
, sum
, percentile
.widget.treemap_definition.request.query.event_query
Required:
compute
(Block List, Min: 1) The compute options. (see below for nested schema)data_source
(String) The data source for event platform-based queries. Valid values are logs
, spans
, network
, rum
, security_signals
, profiles
, audit
, events
, ci_tests
, ci_pipelines
.name
(String) The name of query for use in formulas.Optional:
group_by
(Block List) Group by options. (see below for nested schema)indexes
(List of String) An array of index names to query in the stream.search
(Block List, Max: 1) The search options. (see below for nested schema)storage
(String) Storage location (private beta).widget.treemap_definition.request.query.event_query.compute
Required:
aggregation
(String) The aggregation methods for event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
interval
(Number) A time interval in milliseconds.metric
(String) The measurable attribute to compute.widget.treemap_definition.request.query.event_query.group_by
Required:
facet
(String) The event facet.Optional:
limit
(Number) The number of groups to return.sort
(Block List, Max: 1) The options for sorting group by results. (see below for nested schema)widget.treemap_definition.request.query.event_query.group_by.sort
Required:
aggregation
(String) The aggregation methods for the event platform queries. Valid values are count
, cardinality
, median
, pc75
, pc90
, pc95
, pc98
, pc99
, sum
, min
, max
, avg
.Optional:
metric
(String) The metric used for sorting group by results.order
(String) Direction of sort. Valid values are asc
, desc
.widget.treemap_definition.request.query.event_query.search
Required:
query
(String) The events search string.widget.treemap_definition.request.query.metric_query
Required:
name
(String) The name of the query for use in formulas.query
(String) The metrics query definition.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.data_source
(String) The data source for metrics queries. Defaults to "metrics"
.widget.treemap_definition.request.query.process_query
Required:
data_source
(String) The data source for process queries. Valid values are process
, container
.metric
(String) The process metric name.name
(String) The name of query for use in formulas.Optional:
aggregator
(String) The aggregation methods available for metrics queries. Valid values are avg
, min
, max
, sum
, last
, area
, l2norm
, percentile
.is_normalized_cpu
(Boolean) Whether to normalize the CPU percentages.limit
(Number) The number of hits to return.sort
(String) The direction of the sort. Valid values are asc
, desc
. Defaults to "desc"
.tag_filters
(List of String) An array of tags to filter by.text_filter
(String) The text to use as a filter.widget.treemap_definition.request.query.slo_query
Required:
data_source
(String) The data source for SLO queries. Valid values are slo
.measure
(String) SLO measures queries. Valid values are good_events
, bad_events
, slo_status
, error_budget_remaining
, burn_rate
, error_budget_burndown
.slo_id
(String) ID of an SLO to query.Optional:
additional_query_filters
(String) Additional filters applied to the SLO query.group_mode
(String) Group mode to query measures. Valid values are overall
, components
. Defaults to "overall"
.name
(String) The name of query for use in formulas.slo_query_type
(String) type of the SLO to query. Valid values are metric
. Defaults to "metric"
.widget.widget_layout
Required:
height
(Number) The height of the widget.width
(Number) The width of the widget.x
(Number) The position of the widget on the x (horizontal) axis. Must be greater than or equal to 0.y
(Number) The position of the widget on the y (vertical) axis. Must be greater than or equal to 0.Optional:
is_column_break
(Boolean) Whether the widget should be the first one on the second column in high density or not. Only one widget in the dashboard should have this property set to true
.Import is supported using the following syntax:
terraform import datadog_powerpack.foo 11111111-2222-3333-4444-555555555555