custom_links
\n[object]
A list of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
Array of one request object to display in the widget. The request must contain a group-by tag whose value is a country ISO code.
See the Request JSON schema documentation\nfor information about building the REQUEST_SCHEMA.
columns
\n[object]
Widget columns.
field [required]
\nstring
Widget column field.
width [required]
\nenum
Widget column width. \nAllowed enum values: auto,compact,full
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
The widget metrics query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
query
\nobject
Updated list stream widget.
clustering_pattern_field_path
\nstring
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
\n[object]
Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.
aggregation [required]
\nenum
Aggregation value. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent
facet
\nstring
Facet name.
data_source [required]
\nenum
Source from which to query items to display in the stream. \nAllowed enum values: 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,rum_stream,llm_observability_stream
default: apm_issue_stream
event_size
\nenum
Size to use to display an event. \nAllowed enum values: s,l
group_by
\n[object]
Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.
facet [required]
\nstring
Facet name.
indexes
\n[string]
List of indexes.
query_string [required]
\nstring
Widget query.
sort
\nobject
Which column and order to sort by
column [required]
\nstring
Facet path for the column
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
storage
\nstring
Option for storage location. Feature in Private Beta.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
style [required]
\nobject
The style to apply to the widget.
palette [required]
\nstring
The color palette to apply to the widget.
palette_flip [required]
\nboolean
Whether to flip the palette tones.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
The title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
The size of the title.
type [required]
\nenum
Type of the geomap widget. \nAllowed enum values: geomap
default: geomap
view [required]
\nobject
The view of the world that the map should render.
focus [required]
\nstring
The 2-letter ISO code of a country to focus the map on. Or WORLD.
custom_links
\n[object]
A list of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
Array of one request object to display in the widget. The request must contain a group-by tag whose value is a country ISO code.
See the Request JSON schema documentation\nfor information about building the REQUEST_SCHEMA.
columns
\n[object]
Widget columns.
field [required]
\nstring
Widget column field.
width [required]
\nenum
Widget column width. \nAllowed enum values: auto,compact,full
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
The widget metrics query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
query
\nobject
Updated list stream widget.
clustering_pattern_field_path
\nstring
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
\n[object]
Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.
aggregation [required]
\nenum
Aggregation value. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent
facet
\nstring
Facet name.
data_source [required]
\nenum
Source from which to query items to display in the stream. \nAllowed enum values: 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,rum_stream,llm_observability_stream
default: apm_issue_stream
event_size
\nenum
Size to use to display an event. \nAllowed enum values: s,l
group_by
\n[object]
Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.
facet [required]
\nstring
Facet name.
indexes
\n[string]
List of indexes.
query_string [required]
\nstring
Widget query.
sort
\nobject
Which column and order to sort by
column [required]
\nstring
Facet path for the column
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
storage
\nstring
Option for storage location. Feature in Private Beta.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
style [required]
\nobject
The style to apply to the widget.
palette [required]
\nstring
The color palette to apply to the widget.
palette_flip [required]
\nboolean
Whether to flip the palette tones.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
The title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
The size of the title.
type [required]
\nenum
Type of the geomap widget. \nAllowed enum values: geomap
default: geomap
view [required]
\nobject
The view of the world that the map should render.
custom_extent
\n[number]
A custom extent of the map defined by an array of four numbers in the order [minLongitude, minLatitude, maxLongitude, maxLatitude].
focus [required]
\nstring
The 2-letter ISO code of a country to focus the map on. Or WORLD.
has_uniform_y_axes
\nboolean
Normalize y axes across graphs
size [required]
\nenum
Size of the individual graphs in the split. \nAllowed enum values: xs,sm,md,lg
source_widget_definition [required]
\n<oneOf>
The original widget we are splitting on.
Option 1
\nobject
The Change graph shows you the change in a value over the time period chosen.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
Array of one request object to display in the widget.
\nSee the dedicated Request JSON schema documentation\n to learn how to build the REQUEST_SCHEMA.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
change_type
\nenum
Show the absolute or the relative change. \nAllowed enum values: absolute,relative
compare_to
\nenum
Timeframe used for the change comparison. \nAllowed enum values: hour_before,day_before,week_before,month_before
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
increase_good
\nboolean
Whether to show increase as good.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
order_by
\nenum
What to order by. \nAllowed enum values: change,name,present,past
order_dir
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
show_present
\nboolean
Whether to show the present value.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of the widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the change widget. \nAllowed enum values: change
default: change
Option 2
\nobject
This visualization displays a series of values by country on a world map.
custom_links
\n[object]
A list of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
Array of one request object to display in the widget. The request must contain a group-by tag whose value is a country ISO code.
See the Request JSON schema documentation\nfor information about building the REQUEST_SCHEMA.
columns
\n[object]
Widget columns.
field [required]
\nstring
Widget column field.
width [required]
\nenum
Widget column width. \nAllowed enum values: auto,compact,full
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
The widget metrics query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
query
\nobject
Updated list stream widget.
clustering_pattern_field_path
\nstring
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
\n[object]
Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.
aggregation [required]
\nenum
Aggregation value. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent
facet
\nstring
Facet name.
data_source [required]
\nenum
Source from which to query items to display in the stream. \nAllowed enum values: 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,rum_stream,llm_observability_stream
default: apm_issue_stream
event_size
\nenum
Size to use to display an event. \nAllowed enum values: s,l
group_by
\n[object]
Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.
facet [required]
\nstring
Facet name.
indexes
\n[string]
List of indexes.
query_string [required]
\nstring
Widget query.
sort
\nobject
Which column and order to sort by
column [required]
\nstring
Facet path for the column
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
storage
\nstring
Option for storage location. Feature in Private Beta.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
style [required]
\nobject
The style to apply to the widget.
palette [required]
\nstring
The color palette to apply to the widget.
palette_flip [required]
\nboolean
Whether to flip the palette tones.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
The title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
The size of the title.
type [required]
\nenum
Type of the geomap widget. \nAllowed enum values: geomap
default: geomap
view [required]
\nobject
The view of the world that the map should render.
focus [required]
\nstring
The 2-letter ISO code of a country to focus the map on. Or WORLD.
Option 3
\nobject
Query values display the current value of a given metric, APM, or log query.
autoscale
\nboolean
Whether to use auto-scaling or not.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
custom_unit
\nstring
Display a unit of your choice on the widget.
precision
\nint64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [required]
\n[object]
Widget definition.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
TODO.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
text_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
timeseries_background
\nobject
Set a timeseries on the widget background.
type [required]
\nenum
Timeseries is made using an area or bars. \nAllowed enum values: bars,area
default: area
yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the query value widget. \nAllowed enum values: query_value
default: query_value
Option 4
\nobject
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
\n[string]
List of groups used for colors.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\nobject
Widget definition.
table
\nobject
Scatterplot request containing formulas and functions.
formulas
\n[object]
List of Scatterplot formulas that operate on queries.
alias
\nstring
Expression alias.
dimension [required]
\nenum
Dimension of the Scatterplot. \nAllowed enum values: x,y,radius,color
formula [required]
\nstring
String expression built from queries, formulas, and functions.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
x
\nobject
Updated scatter plot.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
y
\nobject
Updated scatter plot.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the scatter plot widget. \nAllowed enum values: scatterplot
default: scatterplot
xaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
Option 5
\nobject
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
hide_total
\nboolean
Show the total value in this widget.
legend
\n<oneOf>
Configuration of the legend.
Option 1
\nobject
Configuration of table-based legend.
type [required]
\nenum
Whether or not to show a table legend. \nAllowed enum values: table,none
Option 2
\nobject
Configuration of inline or automatic legends.
hide_percent
\nboolean
Whether to hide the percentages of the groups.
hide_value
\nboolean
Whether to hide the values of the groups.
type [required]
\nenum
Whether to show the legend inline or let it be automatically generated. \nAllowed enum values: inline,automatic
requests [required]
\n[object]
List of sunburst widget requests.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Widget query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
style
\nobject
Widget style definition.
palette
\nstring
Color palette to apply to the widget.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the Sunburst widget. \nAllowed enum values: sunburst
default: sunburst
Option 6
\nobject
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
has_search_bar
\nenum
Controls the display of the search bar. \nAllowed enum values: always,never,auto
requests [required]
\n[object]
Widget definition.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
alias
\nstring
The column name (defaults to the metric name).
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
apm_stats_query
\nobject
The APM stats query for table and distributions widgets.
columns
\n[object]
Column properties used by the front end for display.
alias
\nstring
A user-assigned alias for the column.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
name [required]
\nstring
Column name.
order
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
env [required]
\nstring
Environment name.
name [required]
\nstring
Operation name associated with service.
primary_tag [required]
\nstring
The organization's host group name and value.
resource
\nstring
Resource name.
row_type [required]
\nenum
The level of detail for the request. \nAllowed enum values: service,resource,span
service [required]
\nstring
Service name.
cell_display_mode
\n[string]
A list of display modes for each table cell.
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
limit
\nint64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
order
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
text_formats
\n[array]
List of text formats for columns produced by tags.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the table widget. \nAllowed enum values: query_table
default: query_table
Option 7
\nobject
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
events
\n[object]
List of widget events.
q [required]
\nstring
Query definition.
tags_execution
\nstring
The execution method for multi-value filters.
legend_columns
\n[string]
Columns displayed in the legend.
legend_layout
\nenum
Layout of the legend. \nAllowed enum values: auto,horizontal,vertical
legend_size
\nstring
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
\n[object]
List of markers.
display_type
\nstring
Combination of:
\nx_axis_percentile.label
\nstring
Label to display over the marker.
time
\nstring
Timestamp for the widget.
value [required]
\nstring
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10.
requests [required]
\n[object]
List of timeseries widget requests.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
display_type
\nenum
Type of display to use for the request. \nAllowed enum values: area,bars,line,overlay
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
metadata
\n[object]
Used to define expression aliases.
alias_name
\nstring
Expression alias.
expression [required]
\nstring
Expression name.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
on_right_yaxis
\nboolean
Whether or not to display a second y-axis on the right.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Widget query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
style
\nobject
Define request widget style.
line_type
\nenum
Type of lines displayed. \nAllowed enum values: dashed,dotted,solid
line_width
\nenum
Width of line displayed. \nAllowed enum values: normal,thick,thin
palette
\nstring
Color palette to apply to the widget.
right_yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
show_legend
\nboolean
(screenboard only) Show the legend for this widget.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the timeseries widget. \nAllowed enum values: timeseries
default: timeseries
yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
Option 8
\nobject
The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
List of top list widget requests.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Widget query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
style
\nobject
Define request widget style.
line_type
\nenum
Type of lines displayed. \nAllowed enum values: dashed,dotted,solid
line_width
\nenum
Width of line displayed. \nAllowed enum values: normal,thick,thin
palette
\nstring
Color palette to apply to the widget.
style
\nobject
Style customization for a top list widget.
display
\n<oneOf>
Top list widget display options.
Option 1
\nobject
Top list widget stacked display options.
legend
\nenum
Top list widget stacked legend behavior. \nAllowed enum values: automatic,inline,none
type [required]
\nenum
Top list widget stacked display type. \nAllowed enum values: stacked
default: stacked
Option 2
\nobject
Top list widget flat display.
type [required]
\nenum
Top list widget flat display type. \nAllowed enum values: flat
default: flat
palette
\nstring
Color palette to apply to the widget.
scaling
\nenum
Top list widget scaling definition. \nAllowed enum values: absolute,relative
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the top list widget. \nAllowed enum values: toplist
default: toplist
Option 9
\nobject
The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team.
color_by
\nenum
DEPRECATED: (deprecated) The attribute formerly used to determine color in the widget. \nAllowed enum values: user
default: user
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
group_by
\nenum
DEPRECATED: (deprecated) The attribute formerly used to group elements in the widget. \nAllowed enum values: user,family,process
requests [required]
\n[object]
List of treemap widget requests.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
q
\nstring
The widget metrics query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
size_by
\nenum
DEPRECATED: (deprecated) The attribute formerly used to determine size in the widget. \nAllowed enum values: pct_cpu,pct_mem
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
type [required]
\nenum
Type of the treemap widget. \nAllowed enum values: treemap
default: treemap
split_config [required]
\nobject
Encapsulates all user choices about how to split a graph.
limit [required]
\nint64
Maximum number of graphs to display in the widget.
sort [required]
\nobject
Controls the order in which graphs appear in the split.
compute
\nobject
Defines the metric and aggregation used as the sort value.
aggregation [required]
\nstring
How to aggregate the sort metric for the purposes of ordering.
metric [required]
\nstring
The metric to use for sorting graphs.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
split_dimensions [required]
\n[object]
The dimension(s) on which to split the graph
one_graph_per [required]
\nstring
The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag.
static_splits
\n[array]
Manual selection of tags making split graph widget static
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
type [required]
\nenum
Type of the split graph widget \nAllowed enum values: split_group
default: split_group
has_uniform_y_axes
\nboolean
Normalize y axes across graphs
size [required]
\nenum
Size of the individual graphs in the split. \nAllowed enum values: xs,sm,md,lg
source_widget_definition [required]
\n<oneOf>
The original widget we are splitting on.
Option 1
\nobject
The Change graph shows you the change in a value over the time period chosen.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
Array of one request object to display in the widget.
\nSee the dedicated Request JSON schema documentation\n to learn how to build the REQUEST_SCHEMA.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
change_type
\nenum
Show the absolute or the relative change. \nAllowed enum values: absolute,relative
compare_to
\nenum
Timeframe used for the change comparison. \nAllowed enum values: hour_before,day_before,week_before,month_before
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
increase_good
\nboolean
Whether to show increase as good.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
order_by
\nenum
What to order by. \nAllowed enum values: change,name,present,past
order_dir
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
show_present
\nboolean
Whether to show the present value.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of the widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the change widget. \nAllowed enum values: change
default: change
Option 2
\nobject
This visualization displays a series of values by country on a world map.
custom_links
\n[object]
A list of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
Array of one request object to display in the widget. The request must contain a group-by tag whose value is a country ISO code.
See the Request JSON schema documentation\nfor information about building the REQUEST_SCHEMA.
columns
\n[object]
Widget columns.
field [required]
\nstring
Widget column field.
width [required]
\nenum
Widget column width. \nAllowed enum values: auto,compact,full
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
The widget metrics query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
query
\nobject
Updated list stream widget.
clustering_pattern_field_path
\nstring
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
\n[object]
Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.
aggregation [required]
\nenum
Aggregation value. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent
facet
\nstring
Facet name.
data_source [required]
\nenum
Source from which to query items to display in the stream. \nAllowed enum values: 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,rum_stream,llm_observability_stream
default: apm_issue_stream
event_size
\nenum
Size to use to display an event. \nAllowed enum values: s,l
group_by
\n[object]
Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.
facet [required]
\nstring
Facet name.
indexes
\n[string]
List of indexes.
query_string [required]
\nstring
Widget query.
sort
\nobject
Which column and order to sort by
column [required]
\nstring
Facet path for the column
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
storage
\nstring
Option for storage location. Feature in Private Beta.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
style [required]
\nobject
The style to apply to the widget.
palette [required]
\nstring
The color palette to apply to the widget.
palette_flip [required]
\nboolean
Whether to flip the palette tones.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
The title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
The size of the title.
type [required]
\nenum
Type of the geomap widget. \nAllowed enum values: geomap
default: geomap
view [required]
\nobject
The view of the world that the map should render.
custom_extent
\n[number]
A custom extent of the map defined by an array of four numbers in the order [minLongitude, minLatitude, maxLongitude, maxLatitude].
focus [required]
\nstring
The 2-letter ISO code of a country to focus the map on. Or WORLD.
Option 3
\nobject
Query values display the current value of a given metric, APM, or log query.
autoscale
\nboolean
Whether to use auto-scaling or not.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
custom_unit
\nstring
Display a unit of your choice on the widget.
precision
\nint64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [required]
\n[object]
Widget definition.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
TODO.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
text_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
timeseries_background
\nobject
Set a timeseries on the widget background.
type [required]
\nenum
Timeseries is made using an area or bars. \nAllowed enum values: bars,area
default: area
yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the query value widget. \nAllowed enum values: query_value
default: query_value
Option 4
\nobject
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
\n[string]
List of groups used for colors.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\nobject
Widget definition.
table
\nobject
Scatterplot request containing formulas and functions.
formulas
\n[object]
List of Scatterplot formulas that operate on queries.
alias
\nstring
Expression alias.
dimension [required]
\nenum
Dimension of the Scatterplot. \nAllowed enum values: x,y,radius,color
formula [required]
\nstring
String expression built from queries, formulas, and functions.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
x
\nobject
Updated scatter plot.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
y
\nobject
Updated scatter plot.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the scatter plot widget. \nAllowed enum values: scatterplot
default: scatterplot
xaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
Option 5
\nobject
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
hide_total
\nboolean
Show the total value in this widget.
legend
\n<oneOf>
Configuration of the legend.
Option 1
\nobject
Configuration of table-based legend.
type [required]
\nenum
Whether or not to show a table legend. \nAllowed enum values: table,none
Option 2
\nobject
Configuration of inline or automatic legends.
hide_percent
\nboolean
Whether to hide the percentages of the groups.
hide_value
\nboolean
Whether to hide the values of the groups.
type [required]
\nenum
Whether to show the legend inline or let it be automatically generated. \nAllowed enum values: inline,automatic
requests [required]
\n[object]
List of sunburst widget requests.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Widget query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
style
\nobject
Widget style definition.
palette
\nstring
Color palette to apply to the widget.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the Sunburst widget. \nAllowed enum values: sunburst
default: sunburst
Option 6
\nobject
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
has_search_bar
\nenum
Controls the display of the search bar. \nAllowed enum values: always,never,auto
requests [required]
\n[object]
Widget definition.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
alias
\nstring
The column name (defaults to the metric name).
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
apm_stats_query
\nobject
The APM stats query for table and distributions widgets.
columns
\n[object]
Column properties used by the front end for display.
alias
\nstring
A user-assigned alias for the column.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
name [required]
\nstring
Column name.
order
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
env [required]
\nstring
Environment name.
name [required]
\nstring
Operation name associated with service.
primary_tag [required]
\nstring
The organization's host group name and value.
resource
\nstring
Resource name.
row_type [required]
\nenum
The level of detail for the request. \nAllowed enum values: service,resource,span
service [required]
\nstring
Service name.
cell_display_mode
\n[string]
A list of display modes for each table cell.
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
limit
\nint64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
order
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Query definition.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
text_formats
\n[array]
List of text formats for columns produced by tags.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the table widget. \nAllowed enum values: query_table
default: query_table
Option 7
\nobject
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
events
\n[object]
List of widget events.
q [required]
\nstring
Query definition.
tags_execution
\nstring
The execution method for multi-value filters.
legend_columns
\n[string]
Columns displayed in the legend.
legend_layout
\nenum
Layout of the legend. \nAllowed enum values: auto,horizontal,vertical
legend_size
\nstring
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
\n[object]
List of markers.
display_type
\nstring
Combination of:
\nx_axis_percentile.label
\nstring
Label to display over the marker.
time
\nstring
Timestamp for the widget.
value [required]
\nstring
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10.
requests [required]
\n[object]
List of timeseries widget requests.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
display_type
\nenum
Type of display to use for the request. \nAllowed enum values: area,bars,line,overlay
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
metadata
\n[object]
Used to define expression aliases.
alias_name
\nstring
Expression alias.
expression [required]
\nstring
Expression name.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
on_right_yaxis
\nboolean
Whether or not to display a second y-axis on the right.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Widget query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
style
\nobject
Define request widget style.
line_type
\nenum
Type of lines displayed. \nAllowed enum values: dashed,dotted,solid
line_width
\nenum
Width of line displayed. \nAllowed enum values: normal,thick,thin
palette
\nstring
Color palette to apply to the widget.
right_yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
show_legend
\nboolean
(screenboard only) Show the legend for this widget.
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the timeseries widget. \nAllowed enum values: timeseries
default: timeseries
yaxis
\nobject
Axis controls for the widget.
include_zero
\nboolean
Set to true to include zero.
label
\nstring
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
\nstring
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
\nstring
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
\nstring
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
Option 8
\nobject
The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]
\n[object]
List of top list widget requests.
apm_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
audit_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
event_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
log_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
network_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
process_query
\nobject
The process query to use in the widget.
filter_by
\n[string]
List of processes.
limit
\nint64
Max number of items in the filter list.
metric [required]
\nstring
Your chosen metric.
search_by
\nstring
Your chosen search term.
profile_metrics_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
q
\nstring
Widget query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
rum_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
security_query
\nobject
The log query.
compute
\nobject
Define computation for a log query.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
group_by
\n[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
\nstring
Facet name.
limit
\nint64
Maximum number of items in the group.
sort
\nobject
Define a sorting method.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
index
\nstring
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
\n[object]
This field is mutually exclusive with compute.
aggregation [required]
\nstring
The aggregation method.
facet
\nstring
Facet name.
interval
\nint64
Define a time interval in seconds.
search
\nobject
The query being made on the logs.
query [required]
\nstring
Search value to apply.
sort
\nobject
The controls for sorting the widget.
count
\nint64
The number of items to limit the widget to.
order_by
\n[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
\nobject
The formula to sort the widget by.
index [required]
\nint64
The index of the formula to sort by.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to formula. \nAllowed enum values: formula
Option 2
\nobject
The group to sort the widget by.
name [required]
\nstring
The name of the group.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
type [required]
\nenum
Set the sort type to group. \nAllowed enum values: group
style
\nobject
Define request widget style.
line_type
\nenum
Type of lines displayed. \nAllowed enum values: dashed,dotted,solid
line_width
\nenum
Width of line displayed. \nAllowed enum values: normal,thick,thin
palette
\nstring
Color palette to apply to the widget.
style
\nobject
Style customization for a top list widget.
display
\n<oneOf>
Top list widget display options.
Option 1
\nobject
Top list widget stacked display options.
legend
\nenum
Top list widget stacked legend behavior. \nAllowed enum values: automatic,inline,none
type [required]
\nenum
Top list widget stacked display type. \nAllowed enum values: stacked
default: stacked
Option 2
\nobject
Top list widget flat display.
type [required]
\nenum
Top list widget flat display type. \nAllowed enum values: flat
default: flat
palette
\nstring
Color palette to apply to the widget.
scaling
\nenum
Top list widget scaling definition. \nAllowed enum values: absolute,relative
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
title_align
\nenum
How to align the text on the widget. \nAllowed enum values: center,left,right
title_size
\nstring
Size of the title.
type [required]
\nenum
Type of the top list widget. \nAllowed enum values: toplist
default: toplist
Option 9
\nobject
The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team.
color_by
\nenum
DEPRECATED: (deprecated) The attribute formerly used to determine color in the widget. \nAllowed enum values: user
default: user
custom_links
\n[object]
List of custom links.
is_hidden
\nboolean
The flag for toggling context menu link visibility.
label
\nstring
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
\nstring
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
\nstring
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
group_by
\nenum
DEPRECATED: (deprecated) The attribute formerly used to group elements in the widget. \nAllowed enum values: user,family,process
requests [required]
\n[object]
List of treemap widget requests.
formulas
\n[object]
List of formulas that operate on queries.
alias
\nstring
Expression alias.
cell_display_mode
\nenum
Define a display mode for the table cell. \nAllowed enum values: number,bar,trend
cell_display_mode_options
\nobject
Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_type
\nenum
Trend type for the cell display mode options. \nAllowed enum values: area,line,bars
y_scale
\nenum
Y scale for the cell display mode options. \nAllowed enum values: shared,independent
conditional_formats
\n[object]
List of conditional formats.
comparator [required]
\nenum
Comparator to apply. \nAllowed enum values: =,>,>=,<,<=
custom_bg_color
\nstring
Color palette to apply to the background, same values available as palette.
custom_fg_color
\nstring
Color palette to apply to the foreground, same values available as palette.
hide_value
\nboolean
True hides values.
image_url
\nstring
Displays an image as the background.
metric
\nstring
Metric from the request to correlate this conditional format with.
palette [required]
\nenum
Color palette to apply. \nAllowed enum values: 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
timeframe
\nstring
Defines the displayed timeframe.
value [required]
\ndouble
Value for the comparator.
formula [required]
\nstring
String expression built from queries, formulas, and functions.
limit
\nobject
Options for limiting results returned.
count
\nint64
Number of results to return.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
number_format
\nobject
Number format options for the widget.
unit
\n<oneOf>
Number format unit.
Option 1
\nobject
Canonical unit.
per_unit_name
\nstring
The name of the unit per item.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
Option 2
\nobject
Custom unit.
label
\nstring
The label for the custom unit.
type
\nenum
The type of custom unit. \nAllowed enum values: custom_unit_label
unit_scale
\nobject
The definition of NumberFormatUnitScale object.
type
\nenum
The type of unit scale. \nAllowed enum values: canonical_unit
unit_name
\nstring
The name of the unit.
style
\nobject
Styling options for widget formulas.
palette
\nstring
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
\nint64
Index specifying which color to use within the palette.
q
\nstring
The widget metrics query.
queries
\n[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
Option 2
\nobject
A formula and functions events query.
compute [required]
\nobject
Compute options.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
\nint64
A time interval in milliseconds.
metric
\nstring
Measurable attribute to compute.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for event platform-based queries. \nAllowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics
group_by
\n[object]
Group by options.
facet [required]
\nstring
Event facet.
limit
\nint64
Number of groups to return.
sort
\nobject
Options for sorting group by results.
aggregation [required]
\nenum
Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
\nstring
Metric used for sorting group by results.
order
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
indexes
\n[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
\nstring
Name of the query for use in formulas.
search
\nobject
Search options.
query [required]
\nstring
Events search string.
storage
\nstring
Option for storage location. Feature in Private Beta.
Option 3
\nobject
Process query using formulas and functions.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data sources that rely on the process backend. \nAllowed enum values: process,container
is_normalized_cpu
\nboolean
Whether to normalize the CPU percentages.
limit
\nint64
Number of hits to return.
metric [required]
\nstring
Process metric name.
name [required]
\nstring
Name of query for use in formulas.
sort
\nenum
Direction of sort. \nAllowed enum values: asc,desc
default: desc
tag_filters
\n[string]
An array of tags to filter by.
text_filter
\nstring
Text to use as filter.
Option 4
\nobject
A formula and functions APM dependency stats query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM dependency stats queries. \nAllowed enum values: apm_dependency_stats
env [required]
\nstring
APM environment.
is_upstream
\nboolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
\nstring
Name of query to use in formulas.
operation_name [required]
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
\nstring
APM resource.
service [required]
\nstring
APM service.
stat [required]
\nenum
APM statistic. \nAllowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
\nobject
APM resource stats query using formulas and functions.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for APM resource stats queries. \nAllowed enum values: apm_resource_stats
env [required]
\nstring
APM environment.
group_by
\n[string]
Array of fields to group results by.
name [required]
\nstring
Name of this query to use in formulas.
operation_name
\nstring
Name of operation on service.
primary_tag_name
\nstring
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
\nstring
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
\nstring
APM resource name.
service [required]
\nstring
APM service name.
stat [required]
\nenum
APM resource stat name. \nAllowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
Option 6
\nobject
A formula and functions metrics query.
additional_query_filters
\nstring
Additional filters applied to the SLO query.
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for SLO measures queries. \nAllowed enum values: slo
group_mode
\nenum
Group mode to query measures. \nAllowed enum values: overall,components
measure [required]
\nenum
SLO measures queries. \nAllowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
\nstring
Name of the query for use in formulas.
slo_id [required]
\nstring
ID of an SLO to query measures.
slo_query_type
\nenum
Name of the query for use in formulas. \nAllowed enum values: metric,monitor,time_slice
Option 7
\nobject
A formula and functions Cloud Cost query.
aggregator
\nenum
Aggregator used for the request. \nAllowed enum values: avg,last,max,min,sum,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for Cloud Cost queries. \nAllowed enum values: cloud_cost
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Query for Cloud Cost data.
response_format
\nenum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. \nAllowed enum values: timeseries,scalar,event_list
size_by
\nenum
DEPRECATED: (deprecated) The attribute formerly used to determine size in the widget. \nAllowed enum values: pct_cpu,pct_mem
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
type [required]
\nenum
Type of the treemap widget. \nAllowed enum values: treemap
default: treemap
split_config [required]
\nobject
Encapsulates all user choices about how to split a graph.
limit [required]
\nint64
Maximum number of graphs to display in the widget.
sort [required]
\nobject
Controls the order in which graphs appear in the split.
compute
\nobject
Defines the metric and aggregation used as the sort value.
aggregation [required]
\nstring
How to aggregate the sort metric for the purposes of ordering.
metric [required]
\nstring
The metric to use for sorting graphs.
order [required]
\nenum
Widget sorting methods. \nAllowed enum values: asc,desc
split_dimensions [required]
\n[object]
The dimension(s) on which to split the graph
one_graph_per [required]
\nstring
The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag.
static_splits
\n[array]
Manual selection of tags making split graph widget static
time
\n<oneOf>
Time setting for the widget.
Option 1
\nobject
Wrapper for live span
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Option 2
\nobject
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
\nenum
Type "live" denotes a live span in the new format. \nAllowed enum values: live
unit [required]
\nenum
Unit of the time span. \nAllowed enum values: minute,hour,day,week,month,year
value [required]
\nint64
Value of the time span.
Option 3
\nobject
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
\nint64
Start time in seconds since epoch.
to [required]
\nint64
End time in seconds since epoch.
type [required]
\nenum
Type "fixed" denotes a fixed span. \nAllowed enum values: fixed
title
\nstring
Title of your widget.
type [required]
\nenum
Type of the split graph widget \nAllowed enum values: split_group
default: split_group