# Source: https://docs.datadoghq.com/api/latest/dashboards

![](https://d.adroll.com/cm/b/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/bombora/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/experian/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/eyeota/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/g/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/index/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/l/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/n/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/o/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/outbrain/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/pubmatic/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/taboola/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/triplelift/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)![](https://d.adroll.com/cm/x/out?adroll_fpc=4e8a2db038d0bec3cd48425cbc4c4607-1768335890802&pv=22486804871.081673&arrfrr=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&advertisable=AWPYDAH5JJH2JGSUWJVDKM)
# Dashboards
Manage all your dashboards, as well as access to your shared dashboards, through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/) for more information.
## [Create a new dashboard](https://docs.datadoghq.com/api/latest/dashboards/#create-a-new-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#create-a-new-dashboard-v1)


POST https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.ap2.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
### Overview
Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended. Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers. This endpoint requires the `dashboards_write` permission.
OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Request
#### Body Data (required)
Create a dashboard request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Field
Type
Description
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
**DEPRECATED** : Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
layout_type [_required_]
enum
Layout type of the dashboard. Allowed enum values: `ordered,free`
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Allowed enum values: `auto,fixed`
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
tags
[string]
List of team names representing ownership of a dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
**DEPRECATED** : (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`.
values
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`.
template_variables
[object]
List of template variables for this dashboard.
available_values
[string]
The list of values that the template variable drop-down is limited to.
default
string
**DEPRECATED** : (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
title [_required_]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [_required_]
[object]
List of widgets to display on the dashboard.
definition [_required_]
<oneOf>
[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).
Option 1
object
Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the alert graph widget. Allowed enum values: `alert_graph`
default: `alert_graph`
viz_type [_required_]
enum
Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist`
Option 2
object
Alert values are query values showing the current value of the metric in any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
precision
int64
Number of decimal to show. If not defined, will use the raw value.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of value in the widget.
type [_required_]
enum
Type of the alert value widget. Allowed enum values: `alert_value`
default: `alert_value`
unit
string
Unit to display with the value.
Option 3
object
The Change graph shows you the change in a value over the time period chosen.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
Option 4
object
Check status shows the current status or number of results for any check performed.
check [_required_]
string
Name of the check to use in the widget.
group
string
Group reporting a single check.
group_by
[string]
List of tag prefixes to group by in the case of a cluster check.
grouping [_required_]
enum
The kind of grouping to use. Allowed enum values: `check,cluster`
tags
[string]
List of tags used to filter the groups reporting a cluster check.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the check status widget. Allowed enum values: `check_status`
default: `check_status`
Option 5
object
The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
legend_size
string
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
<oneOf>
Query definition for Distribution Widget Histogram Request
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the distribution widget. Allowed enum values: `distribution`
default: `distribution`
xaxis
object
X Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
max
string
Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
num_buckets
int64
Number of value buckets to target, also known as the resolution of the value bins.
scale
string
Specifies the scale type. Possible values are `linear`.
default: `linear`
yaxis
object
Y Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
label
string
The label of the axis to display on the graph.
max
string
Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear` or `log`.
default: `linear`
Option 6
object
The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.
event_size
enum
Size to use to display an event. Allowed enum values: `s,l`
query [_required_]
string
Query to filter the event stream with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event stream widget. Allowed enum values: `event_stream`
default: `event_stream`
Option 7
object
The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.
query [_required_]
string
Query to filter the event timeline with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event timeline widget. Allowed enum values: `event_timeline`
default: `event_timeline`
Option 8
object
Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
color
string
Color of the text.
font_size
string
Size of the text.
text [_required_]
string
Text to display.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the free text widget. Allowed enum values: `free_text`
default: `free_text`
Option 9
object
The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
requests [_required_]
[object]
Request payload used to query items.
query [_required_]
object
Updated funnel widget.
data_source [_required_]
enum
Source from which to query items to display in the funnel. Allowed enum values: `rum`
default: `rum`
query_string [_required_]
string
The widget query.
steps [_required_]
[object]
List of funnel steps.
facet [_required_]
string
The facet of the step.
value [_required_]
string
The value of the step.
request_type [_required_]
enum
Widget request type. Allowed enum values: `funnel`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of funnel widget. Allowed enum values: `funnel`
default: `funnel`
Option 10
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
columns
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
conditional_formats
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
text_formats
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
match [_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
replace
<oneOf>
Replace rule for the table widget text format.
Option 1
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
Option 2
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
style [_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
view [_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
Option 11
object
The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the group title.
banner_img
string
URL of image to display as a banner for the group.
layout_type [_required_]
enum
Layout type of the group. Allowed enum values: `ordered`
show_title
boolean
Whether to show the title or not.
default: `true`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the group widget. Allowed enum values: `group`
default: `group`
widgets [_required_]
[object]
List of widget groups.
Option 12
object
The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of widget types.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The event query.
search [_required_]
string
The query being made on the event.
tags_execution [_required_]
string
The execution method for multi-value filters. Can be either and or or.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the heat map widget. Allowed enum values: `heatmap`
default: `heatmap`
xaxis
object
X Axis controls for the heat map widget.
num_buckets
int64
Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier).
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 13
object
The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group
[string]
List of tag prefixes to group by.
no_group_hosts
boolean
Whether to show the hosts that don’t fit in a group.
no_metric_hosts
boolean
Whether to show the hosts with no metrics.
node_type
enum
Which type of node to use in the map. Allowed enum values: `host,container`
notes
string
Notes on the title.
requests [_required_]
object
List of definitions.
fill
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
size
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
scope
[string]
List of tags used to filter the map.
style
object
The style to apply to the widget.
fill_max
string
Max value to use to color the map.
fill_min
string
Min value to use to color the map.
palette
string
Color palette to apply to the widget.
palette_flip
boolean
Whether to flip the palette tones.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the host map widget. Allowed enum values: `hostmap`
default: `hostmap`
Option 14
object
The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
type [_required_]
enum
Type of the iframe widget. Allowed enum values: `iframe`
default: `iframe`
url [_required_]
string
URL of the iframe.
Option 15
object
The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
has_background
boolean
Whether to display a background or not.
default: `true`
has_border
boolean
Whether to display a border or not.
default: `true`
horizontal_align
enum
Horizontal alignment. Allowed enum values: `center,left,right`
margin
enum
Size of the margins around the image. **Note** : `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large`
sizing
enum
How to size the image on the widget. The values are based on the image `object-fit` CSS properties. **Note** : `zoom`, `fit` and `center` values are deprecated. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center`
type [_required_]
enum
Type of the image widget. Allowed enum values: `image`
default: `image`
url [_required_]
string
URL of the image.
url_dark_theme
string
URL of the image in dark mode.
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 16
object
The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
requests [_required_]
[object]
Request payload used to query items.
columns [_required_]
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
query [_required_]
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format [_required_]
enum
Widget response format. Allowed enum values: `event_list`
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the list stream widget. Allowed enum values: `list_stream`
default: `list_stream`
Option 17
object
The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
columns
[string]
Which columns to display on the widget.
indexes
[string]
An array of index names to query in the stream. Use [] to query all indexes at once.
logset
string
**DEPRECATED** : ID of the log set to use.
message_display
enum
Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg`
query
string
Query to filter the log stream with.
show_date_column
boolean
Whether to show the date column or not
show_message_column
boolean
Whether to show the message column or not
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the log stream widget. Allowed enum values: `log_stream`
default: `log_stream`
Option 18
object
The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
color_preference
enum
Which color to use on the widget. Allowed enum values: `background,text`
count
int64
**DEPRECATED** : The number of monitors to display.
display_format
enum
What to display on the widget. Allowed enum values: `counts,countsAndList,list`
hide_zero_counts
boolean
Whether to show counts of 0 or not.
query [_required_]
string
Query to filter the monitors with.
show_last_triggered
boolean
Whether to show the time that has elapsed since the monitor/group triggered.
show_priority
boolean
Whether to show the priorities column.
sort
enum
Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc,status,desc,tags,asc,tags,desc,triggered,asc,triggered,desc,priority,asc,priority,desc`
start
int64
**DEPRECATED** : The start of the list. Typically 0.
summary_type
enum
Which summary type should be used. Allowed enum values: `monitors,groups,combined`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the monitor summary widget. Allowed enum values: `manage_status`
default: `manage_status`
Option 19
object
The notes and links widget is similar to free text widget, but allows for more formatting options.
background_color
string
Background color of the note.
content [_required_]
string
Content of the note.
font_size
string
Size of the text.
has_padding
boolean
Whether to add padding or not.
default: `true`
show_tick
boolean
Whether to show a tick or not.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
tick_edge
enum
Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top`
tick_pos
string
Where to position the tick on an edge.
type [_required_]
enum
Type of the note widget. Allowed enum values: `note`
default: `note`
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 20
object
The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the powerpack title.
banner_img
string
URL of image to display as a banner for the powerpack.
powerpack_id [_required_]
string
UUID of the associated powerpack.
show_title
boolean
Whether to show the title or not.
default: `true`
template_variables
object
Powerpack template variables.
controlled_by_powerpack
[object]
Template variables controlled at the powerpack level.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
controlled_externally
[object]
Template variables controlled by the external resource, such as the dashboard this powerpack is on.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
title
string
Title of the widget.
type [_required_]
enum
Type of the powerpack widget. Allowed enum values: `powerpack`
default: `powerpack`
Option 21
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
timeseries_background
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
Option 22
object
Run workflow is widget that allows you to run a workflow from a dashboard.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
inputs
[object]
Array of workflow inputs to map to dashboard template variables.
name [_required_]
string
Name of the workflow input.
value [_required_]
string
Dashboard template variable. Can be suffixed with '.value' or '.key'.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the run workflow widget. Allowed enum values: `run_workflow`
default: `run_workflow`
workflow_id [_required_]
string
Workflow id.
Option 23
object
Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
requests [_required_]
[object]
Array of one request object to display in the widget.
query [_required_]
object
Updated SLO List widget.
limit
int64
Maximum number of results to display in the table.
default: `100`
query_string [_required_]
string
Widget query.
sort
[object]
Options for sorting results.
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
request_type [_required_]
enum
Widget request type. Allowed enum values: `slo_list`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO List widget. Allowed enum values: `slo_list`
default: `slo_list`
Option 24
object
Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
additional_query_filters
string
Additional filters applied to the SLO query.
global_time_target
string
Defined global time target.
show_error_budget
boolean
Defined error budget.
slo_id
string
ID of the SLO displayed.
time_windows
[string]
Times being monitored.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO widget. Allowed enum values: `slo`
default: `slo`
view_mode
enum
Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both`
view_type [_required_]
string
Type of view displayed by the widget.
default: `detail`
Option 25
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
object
Widget definition.
table
object
Scatterplot request containing formulas and functions.
formulas
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
x
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
y
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
xaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 26
object
This widget displays a map of a service to all of the services that call it, and all of the services that it calls.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
filters [_required_]
[string]
Your environment and primary tag (or * if enabled for your account).
service [_required_]
string
The ID of the service you want to map.
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service map widget. Allowed enum values: `servicemap`
default: `servicemap`
Option 27
object
The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
display_format
enum
Number of columns to display. Allowed enum values: `one_column,two_column,three_column`
env [_required_]
string
APM environment.
service [_required_]
string
APM service.
show_breakdown
boolean
Whether to show the latency breakdown or not.
show_distribution
boolean
Whether to show the latency distribution or not.
show_errors
boolean
Whether to show the error metrics or not.
show_hits
boolean
Whether to show the hits metrics or not.
show_latency
boolean
Whether to show the latency metrics or not.
show_resource_list
boolean
Whether to show the resource list or not.
size_format
enum
Size of the widget. Allowed enum values: `small,medium,large`
span_name [_required_]
string
APM span name.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service summary widget. Allowed enum values: `trace_service`
default: `trace_service`
Option 28
object
The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service)
has_uniform_y_axes
boolean
Normalize y axes across graphs
size [_required_]
enum
Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg`
source_widget_definition [_required_]
<oneOf>
The original widget we are splitting on.
Option 1
object
The Change graph shows you the change in a value over the time period chosen.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
Option 2
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
columns
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
conditional_formats
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
text_formats
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
match [_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
replace
<oneOf>
Replace rule for the table widget text format.
Option 1
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
Option 2
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
style [_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
view [_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
Option 3
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
timeseries_background
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
Option 4
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
object
Widget definition.
table
object
Scatterplot request containing formulas and functions.
formulas
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
x
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
y
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
xaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 5
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
legend
<oneOf>
Configuration of the legend.
Option 1
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
Option 2
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
requests [_required_]
[object]
List of sunburst widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
Option 6
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
Option 7
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of timeseries widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
metadata
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
right_yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 8
object
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
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
List of top list widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
style
object
Style customization for a top list widget.
display
<oneOf>
Top list widget display options.
Option 1
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
Option 2
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
Option 9
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
requests [_required_]
[object]
List of treemap widget requests.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
split_config [_required_]
object
Encapsulates all user choices about how to split a graph.
limit [_required_]
int64
Maximum number of graphs to display in the widget.
sort [_required_]
object
Controls the order in which graphs appear in the split.
compute
object
Defines the metric and aggregation used as the sort value.
aggregation [_required_]
string
How to aggregate the sort metric for the purposes of ordering.
metric [_required_]
string
The metric to use for sorting graphs.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
split_dimensions [_required_]
[object]
The dimension(s) on which to split the graph
one_graph_per [_required_]
string
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
[array]
Manual selection of tags making split graph widget static
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the split graph widget Allowed enum values: `split_group`
default: `split_group`
Option 29
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
legend
<oneOf>
Configuration of the legend.
Option 1
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
Option 2
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
requests [_required_]
[object]
List of sunburst widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
Option 30
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
Option 31
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of timeseries widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
metadata
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
right_yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 32
object
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
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
List of top list widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
style
object
Style customization for a top list widget.
display
<oneOf>
Top list widget display options.
Option 1
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
Option 2
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
Option 33
object
This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
One or more Topology requests.
query
object
Query to service-based topology data sources like the service map or data streams.
data_source
enum
Name of the data source Allowed enum values: `data_streams,service_map`
filters
[string]
Your environment and primary tag (or * if enabled for your account).
service
string
Name of the service
request_type
enum
Widget request type. Allowed enum values: `topology`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the topology map widget. Allowed enum values: `topology_map`
default: `topology_map`
Option 34
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
requests [_required_]
[object]
List of treemap widget requests.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
id
int64
ID of the widget.
layout
object
The layout for a widget on a `free` or **new dashboard layout** dashboard.
height [_required_]
int64
The height of the widget. Should be a non-negative integer.
is_column_break
boolean
Whether the widget should be the first one on the second column in high density or not. **Note** : Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`.
width [_required_]
int64
The width of the widget. Should be a non-negative integer.
x [_required_]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [_required_]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
#####  Clients deserialize a dashboard with a empty time object
```
{
  "title": "Example-Dashboard",
  "widgets": [
    {
      "definition": {
        "title": "Example Cloud Cost Query",
        "title_size": "16",
        "title_align": "left",
        "type": "timeseries",
        "requests": [
          {
            "formulas": [
              {
                "formula": "query1"
              }
            ],
            "queries": [
              {
                "data_source": "cloud_cost",
                "name": "query1",
                "query": "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)"
              }
            ],
            "response_format": "timeseries",
            "style": {
              "palette": "dog_classic",
              "line_type": "solid",
              "line_width": "normal"
            },
            "display_type": "bars"
          }
        ],
        "time": {}
      }
    }
  ],
  "layout_type": "ordered"
}
```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
```
{
  "title": "Example-Dashboard",
  "description": "",
  "widgets": [
    {
      "definition": {
        "title": "APM Stats - Request latency HOP",
        "title_size": "16",
        "title_align": "left",
        "show_legend": false,
        "type": "distribution",
        "xaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "yaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "requests": [
          {
            "query": {
              "primary_tag_value": "*",
              "stat": "latency_distribution",
              "data_source": "apm_resource_stats",
              "name": "query1",
              "service": "azure-bill-import",
              "group_by": [
                "resource_name"
              ],
              "env": "staging",
              "primary_tag_name": "datacenter",
              "operation_name": "universal.http.client"
            },
            "request_type": "histogram",
            "style": {
              "palette": "dog_classic"
            }
          }
        ]
      },
      "layout": {
        "x": 8,
        "y": 0,
        "width": 4,
        "height": 2
      }
    }
  ],
  "layout_type": "ordered"
}
```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions events query
```
{
  "title": "Example-Dashboard",
  "description": "Example-Dashboard",
  "widgets": [
    {
      "definition": {
        "title": "Events Platform - Request latency HOP",
        "title_size": "16",
        "title_align": "left",
        "show_legend": false,
        "type": "distribution",
        "xaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "yaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "requests": [
          {
            "query": {
              "search": {
                "query": ""
              },
              "data_source": "events",
              "compute": {
                "metric": "@duration",
                "aggregation": "min"
              },
              "name": "query1",
              "indexes": [
                "*"
              ],
              "group_by": []
            },
            "request_type": "histogram"
          }
        ]
      },
      "layout": {
        "x": 0,
        "y": 0,
        "width": 4,
        "height": 2
      }
    }
  ],
  "layout_type": "ordered"
}
```

Copy
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#CreateDashboard-200-v1)
  * [400](https://docs.datadoghq.com/api/latest/dashboards/#CreateDashboard-400-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#CreateDashboard-403-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#CreateDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.
Field
Type
Description
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
**DEPRECATED** : Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
layout_type [_required_]
enum
Layout type of the dashboard. Allowed enum values: `ordered,free`
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Allowed enum values: `auto,fixed`
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
tags
[string]
List of team names representing ownership of a dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
**DEPRECATED** : (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`.
values
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`.
template_variables
[object]
List of template variables for this dashboard.
available_values
[string]
The list of values that the template variable drop-down is limited to.
default
string
**DEPRECATED** : (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
title [_required_]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [_required_]
[object]
List of widgets to display on the dashboard.
definition [_required_]
<oneOf>
[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).
Option 1
object
Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the alert graph widget. Allowed enum values: `alert_graph`
default: `alert_graph`
viz_type [_required_]
enum
Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist`
Option 2
object
Alert values are query values showing the current value of the metric in any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
precision
int64
Number of decimal to show. If not defined, will use the raw value.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of value in the widget.
type [_required_]
enum
Type of the alert value widget. Allowed enum values: `alert_value`
default: `alert_value`
unit
string
Unit to display with the value.
Option 3
object
The Change graph shows you the change in a value over the time period chosen.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
Option 4
object
Check status shows the current status or number of results for any check performed.
check [_required_]
string
Name of the check to use in the widget.
group
string
Group reporting a single check.
group_by
[string]
List of tag prefixes to group by in the case of a cluster check.
grouping [_required_]
enum
The kind of grouping to use. Allowed enum values: `check,cluster`
tags
[string]
List of tags used to filter the groups reporting a cluster check.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the check status widget. Allowed enum values: `check_status`
default: `check_status`
Option 5
object
The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
legend_size
string
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
<oneOf>
Query definition for Distribution Widget Histogram Request
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the distribution widget. Allowed enum values: `distribution`
default: `distribution`
xaxis
object
X Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
max
string
Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
num_buckets
int64
Number of value buckets to target, also known as the resolution of the value bins.
scale
string
Specifies the scale type. Possible values are `linear`.
default: `linear`
yaxis
object
Y Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
label
string
The label of the axis to display on the graph.
max
string
Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear` or `log`.
default: `linear`
Option 6
object
The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.
event_size
enum
Size to use to display an event. Allowed enum values: `s,l`
query [_required_]
string
Query to filter the event stream with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event stream widget. Allowed enum values: `event_stream`
default: `event_stream`
Option 7
object
The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.
query [_required_]
string
Query to filter the event timeline with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event timeline widget. Allowed enum values: `event_timeline`
default: `event_timeline`
Option 8
object
Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
color
string
Color of the text.
font_size
string
Size of the text.
text [_required_]
string
Text to display.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the free text widget. Allowed enum values: `free_text`
default: `free_text`
Option 9
object
The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
requests [_required_]
[object]
Request payload used to query items.
query [_required_]
object
Updated funnel widget.
data_source [_required_]
enum
Source from which to query items to display in the funnel. Allowed enum values: `rum`
default: `rum`
query_string [_required_]
string
The widget query.
steps [_required_]
[object]
List of funnel steps.
facet [_required_]
string
The facet of the step.
value [_required_]
string
The value of the step.
request_type [_required_]
enum
Widget request type. Allowed enum values: `funnel`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of funnel widget. Allowed enum values: `funnel`
default: `funnel`
Option 10
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
columns
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
conditional_formats
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
text_formats
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
match [_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
replace
<oneOf>
Replace rule for the table widget text format.
Option 1
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
Option 2
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
style [_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
view [_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
Option 11
object
The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the group title.
banner_img
string
URL of image to display as a banner for the group.
layout_type [_required_]
enum
Layout type of the group. Allowed enum values: `ordered`
show_title
boolean
Whether to show the title or not.
default: `true`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the group widget. Allowed enum values: `group`
default: `group`
widgets [_required_]
[object]
List of widget groups.
Option 12
object
The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of widget types.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The event query.
search [_required_]
string
The query being made on the event.
tags_execution [_required_]
string
The execution method for multi-value filters. Can be either and or or.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the heat map widget. Allowed enum values: `heatmap`
default: `heatmap`
xaxis
object
X Axis controls for the heat map widget.
num_buckets
int64
Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier).
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 13
object
The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group
[string]
List of tag prefixes to group by.
no_group_hosts
boolean
Whether to show the hosts that don’t fit in a group.
no_metric_hosts
boolean
Whether to show the hosts with no metrics.
node_type
enum
Which type of node to use in the map. Allowed enum values: `host,container`
notes
string
Notes on the title.
requests [_required_]
object
List of definitions.
fill
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
size
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
scope
[string]
List of tags used to filter the map.
style
object
The style to apply to the widget.
fill_max
string
Max value to use to color the map.
fill_min
string
Min value to use to color the map.
palette
string
Color palette to apply to the widget.
palette_flip
boolean
Whether to flip the palette tones.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the host map widget. Allowed enum values: `hostmap`
default: `hostmap`
Option 14
object
The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
type [_required_]
enum
Type of the iframe widget. Allowed enum values: `iframe`
default: `iframe`
url [_required_]
string
URL of the iframe.
Option 15
object
The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
has_background
boolean
Whether to display a background or not.
default: `true`
has_border
boolean
Whether to display a border or not.
default: `true`
horizontal_align
enum
Horizontal alignment. Allowed enum values: `center,left,right`
margin
enum
Size of the margins around the image. **Note** : `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large`
sizing
enum
How to size the image on the widget. The values are based on the image `object-fit` CSS properties. **Note** : `zoom`, `fit` and `center` values are deprecated. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center`
type [_required_]
enum
Type of the image widget. Allowed enum values: `image`
default: `image`
url [_required_]
string
URL of the image.
url_dark_theme
string
URL of the image in dark mode.
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 16
object
The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
requests [_required_]
[object]
Request payload used to query items.
columns [_required_]
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
query [_required_]
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format [_required_]
enum
Widget response format. Allowed enum values: `event_list`
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the list stream widget. Allowed enum values: `list_stream`
default: `list_stream`
Option 17
object
The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
columns
[string]
Which columns to display on the widget.
indexes
[string]
An array of index names to query in the stream. Use [] to query all indexes at once.
logset
string
**DEPRECATED** : ID of the log set to use.
message_display
enum
Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg`
query
string
Query to filter the log stream with.
show_date_column
boolean
Whether to show the date column or not
show_message_column
boolean
Whether to show the message column or not
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the log stream widget. Allowed enum values: `log_stream`
default: `log_stream`
Option 18
object
The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
color_preference
enum
Which color to use on the widget. Allowed enum values: `background,text`
count
int64
**DEPRECATED** : The number of monitors to display.
display_format
enum
What to display on the widget. Allowed enum values: `counts,countsAndList,list`
hide_zero_counts
boolean
Whether to show counts of 0 or not.
query [_required_]
string
Query to filter the monitors with.
show_last_triggered
boolean
Whether to show the time that has elapsed since the monitor/group triggered.
show_priority
boolean
Whether to show the priorities column.
sort
enum
Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc,status,desc,tags,asc,tags,desc,triggered,asc,triggered,desc,priority,asc,priority,desc`
start
int64
**DEPRECATED** : The start of the list. Typically 0.
summary_type
enum
Which summary type should be used. Allowed enum values: `monitors,groups,combined`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the monitor summary widget. Allowed enum values: `manage_status`
default: `manage_status`
Option 19
object
The notes and links widget is similar to free text widget, but allows for more formatting options.
background_color
string
Background color of the note.
content [_required_]
string
Content of the note.
font_size
string
Size of the text.
has_padding
boolean
Whether to add padding or not.
default: `true`
show_tick
boolean
Whether to show a tick or not.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
tick_edge
enum
Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top`
tick_pos
string
Where to position the tick on an edge.
type [_required_]
enum
Type of the note widget. Allowed enum values: `note`
default: `note`
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 20
object
The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the powerpack title.
banner_img
string
URL of image to display as a banner for the powerpack.
powerpack_id [_required_]
string
UUID of the associated powerpack.
show_title
boolean
Whether to show the title or not.
default: `true`
template_variables
object
Powerpack template variables.
controlled_by_powerpack
[object]
Template variables controlled at the powerpack level.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
controlled_externally
[object]
Template variables controlled by the external resource, such as the dashboard this powerpack is on.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
title
string
Title of the widget.
type [_required_]
enum
Type of the powerpack widget. Allowed enum values: `powerpack`
default: `powerpack`
Option 21
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
timeseries_background
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
Option 22
object
Run workflow is widget that allows you to run a workflow from a dashboard.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
inputs
[object]
Array of workflow inputs to map to dashboard template variables.
name [_required_]
string
Name of the workflow input.
value [_required_]
string
Dashboard template variable. Can be suffixed with '.value' or '.key'.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the run workflow widget. Allowed enum values: `run_workflow`
default: `run_workflow`
workflow_id [_required_]
string
Workflow id.
Option 23
object
Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
requests [_required_]
[object]
Array of one request object to display in the widget.
query [_required_]
object
Updated SLO List widget.
limit
int64
Maximum number of results to display in the table.
default: `100`
query_string [_required_]
string
Widget query.
sort
[object]
Options for sorting results.
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
request_type [_required_]
enum
Widget request type. Allowed enum values: `slo_list`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO List widget. Allowed enum values: `slo_list`
default: `slo_list`
Option 24
object
Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
additional_query_filters
string
Additional filters applied to the SLO query.
global_time_target
string
Defined global time target.
show_error_budget
boolean
Defined error budget.
slo_id
string
ID of the SLO displayed.
time_windows
[string]
Times being monitored.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO widget. Allowed enum values: `slo`
default: `slo`
view_mode
enum
Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both`
view_type [_required_]
string
Type of view displayed by the widget.
default: `detail`
Option 25
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
object
Widget definition.
table
object
Scatterplot request containing formulas and functions.
formulas
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
x
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
y
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
xaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 26
object
This widget displays a map of a service to all of the services that call it, and all of the services that it calls.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
filters [_required_]
[string]
Your environment and primary tag (or * if enabled for your account).
service [_required_]
string
The ID of the service you want to map.
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service map widget. Allowed enum values: `servicemap`
default: `servicemap`
Option 27
object
The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
display_format
enum
Number of columns to display. Allowed enum values: `one_column,two_column,three_column`
env [_required_]
string
APM environment.
service [_required_]
string
APM service.
show_breakdown
boolean
Whether to show the latency breakdown or not.
show_distribution
boolean
Whether to show the latency distribution or not.
show_errors
boolean
Whether to show the error metrics or not.
show_hits
boolean
Whether to show the hits metrics or not.
show_latency
boolean
Whether to show the latency metrics or not.
show_resource_list
boolean
Whether to show the resource list or not.
size_format
enum
Size of the widget. Allowed enum values: `small,medium,large`
span_name [_required_]
string
APM span name.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service summary widget. Allowed enum values: `trace_service`
default: `trace_service`
Option 28
object
The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service)
has_uniform_y_axes
boolean
Normalize y axes across graphs
size [_required_]
enum
Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg`
source_widget_definition [_required_]
<oneOf>
The original widget we are splitting on.
Option 1
object
The Change graph shows you the change in a value over the time period chosen.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
Option 2
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
columns
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
conditional_formats
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
text_formats
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
match [_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
replace
<oneOf>
Replace rule for the table widget text format.
Option 1
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
Option 2
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
style [_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
view [_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
Option 3
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
timeseries_background
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
Option 4
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
object
Widget definition.
table
object
Scatterplot request containing formulas and functions.
formulas
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
x
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
y
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
xaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 5
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
legend
<oneOf>
Configuration of the legend.
Option 1
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
Option 2
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
requests [_required_]
[object]
List of sunburst widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
Option 6
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
Option 7
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of timeseries widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
metadata
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
right_yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 8
object
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
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
List of top list widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
style
object
Style customization for a top list widget.
display
<oneOf>
Top list widget display options.
Option 1
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
Option 2
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
Option 9
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
requests [_required_]
[object]
List of treemap widget requests.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
split_config [_required_]
object
Encapsulates all user choices about how to split a graph.
limit [_required_]
int64
Maximum number of graphs to display in the widget.
sort [_required_]
object
Controls the order in which graphs appear in the split.
compute
object
Defines the metric and aggregation used as the sort value.
aggregation [_required_]
string
How to aggregate the sort metric for the purposes of ordering.
metric [_required_]
string
The metric to use for sorting graphs.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
split_dimensions [_required_]
[object]
The dimension(s) on which to split the graph
one_graph_per [_required_]
string
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
[array]
Manual selection of tags making split graph widget static
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the split graph widget Allowed enum values: `split_group`
default: `split_group`
Option 29
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
legend
<oneOf>
Configuration of the legend.
Option 1
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
Option 2
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
requests [_required_]
[object]
List of sunburst widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
Option 30
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
Option 31
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of timeseries widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
metadata
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
right_yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 32
object
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
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
List of top list widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
style
object
Style customization for a top list widget.
display
<oneOf>
Top list widget display options.
Option 1
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
Option 2
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
Option 33
object
This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
One or more Topology requests.
query
object
Query to service-based topology data sources like the service map or data streams.
data_source
enum
Name of the data source Allowed enum values: `data_streams,service_map`
filters
[string]
Your environment and primary tag (or * if enabled for your account).
service
string
Name of the service
request_type
enum
Widget request type. Allowed enum values: `topology`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the topology map widget. Allowed enum values: `topology_map`
default: `topology_map`
Option 34
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
requests [_required_]
[object]
List of treemap widget requests.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
id
int64
ID of the widget.
layout
object
The layout for a widget on a `free` or **new dashboard layout** dashboard.
height [_required_]
int64
The height of the widget. Should be a non-negative integer.
is_column_break
boolean
Whether the widget should be the first one on the second column in high density or not. **Note** : Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`.
width [_required_]
int64
The width of the widget. Should be a non-negative integer.
x [_required_]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [_required_]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
```
{
  "author_handle": "test@datadoghq.com",
  "author_name": "John Doe",
  "created_at": "2019-09-19T10:00:00.000Z",
  "description": "string",
  "id": "123-abc-456",
  "is_read_only": false,
  "layout_type": "ordered",
  "modified_at": "2019-09-19T10:00:00.000Z",
  "notify_list": [],
  "reflow_type": "string",
  "restricted_roles": [],
  "tags": [],
  "template_variable_presets": [
    {
      "name": "string",
      "template_variables": [
        {
          "name": "string",
          "value": "string",
          "values": []
        }
      ]
    }
  ],
  "template_variables": [
    {
      "available_values": [
        "my-host",
        "host1",
        "host2"
      ],
      "default": "my-host",
      "defaults": [
        "my-host-1",
        "my-host-2"
      ],
      "name": "host1",
      "prefix": "host",
      "type": "group"
    }
  ],
  "title": "",
  "url": "/dashboard/123-abc-456/example-dashboard-title",
  "widgets": [
    {
      "definition": {
        "requests": {
          "fill": {
            "q": "avg:system.cpu.user{*}"
          }
        },
        "type": "hostmap"
      },
      "id": "integer",
      "layout": {
        "height": 0,
        "is_column_break": false,
        "width": 0,
        "x": 0,
        "y": 0
      }
    }
  ]
}
```

Copy
Bad Request
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Authentication Error
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)
  * [Python [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python-legacy)
  * [Ruby [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby-legacy)


#####  Clients deserialize a dashboard with a empty time object
Copy
```
                          # Curl command  
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "title": "Example-Dashboard",
  "widgets": [
    {
      "definition": {
        "title": "Example Cloud Cost Query",
        "title_size": "16",
        "title_align": "left",
        "type": "timeseries",
        "requests": [
          {
            "formulas": [
              {
                "formula": "query1"
              }
            ],
            "queries": [
              {
                "data_source": "cloud_cost",
                "name": "query1",
                "query": "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)"
              }
            ],
            "response_format": "timeseries",
            "style": {
              "palette": "dog_classic",
              "line_type": "solid",
              "line_width": "normal"
            },
            "display_type": "bars"
          }
        ],
        "time": {}
      }
    }
  ],
  "layout_type": "ordered"
}
EOF  

                        
```

#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
Copy
```
                          # Curl command  
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "title": "Example-Dashboard",
  "description": "",
  "widgets": [
    {
      "definition": {
        "title": "APM Stats - Request latency HOP",
        "title_size": "16",
        "title_align": "left",
        "show_legend": false,
        "type": "distribution",
        "xaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "yaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "requests": [
          {
            "query": {
              "primary_tag_value": "*",
              "stat": "latency_distribution",
              "data_source": "apm_resource_stats",
              "name": "query1",
              "service": "azure-bill-import",
              "group_by": [
                "resource_name"
              ],
              "env": "staging",
              "primary_tag_name": "datacenter",
              "operation_name": "universal.http.client"
            },
            "request_type": "histogram",
            "style": {
              "palette": "dog_classic"
            }
          }
        ]
      },
      "layout": {
        "x": 8,
        "y": 0,
        "width": 4,
        "height": 2
      }
    }
  ],
  "layout_type": "ordered"
}
EOF  

                        
```

#####  Create a distribution widget using a histogram request containing a formulas and functions events query
Copy
```
                          # Curl command  
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "title": "Example-Dashboard",
  "description": "Example-Dashboard",
  "widgets": [
    {
      "definition": {
        "title": "Events Platform - Request latency HOP",
        "title_size": "16",
        "title_align": "left",
        "show_legend": false,
        "type": "distribution",
        "xaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "yaxis": {
          "max": "auto",
          "include_zero": true,
          "scale": "linear",
          "min": "auto"
        },
        "requests": [
          {
            "query": {
              "search": {
                "query": ""
              },
              "data_source": "events",
              "compute": {
                "metric": "@duration",
                "aggregation": "min"
              },
              "name": "query1",
              "indexes": [
                "*"
              ],
              "group_by": []
            },
            "request_type": "histogram"
          }
        ]
      },
      "layout": {
        "x": 0,
        "y": 0,
        "width": 4,
        "height": 2
      }
    }
  ],
  "layout_type": "ordered"
}
EOF  

                        
```

#####  Clients deserialize a dashboard with a empty time object 
```
// Clients deserialize a dashboard with a empty time object

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	body := datadogV1.Dashboard{
		Title: "Example-Dashboard",
		Widgets: []datadogV1.Widget{
			{
				Definition: datadogV1.WidgetDefinition{
					TimeseriesWidgetDefinition: &datadogV1.TimeseriesWidgetDefinition{
						Title:      datadog.PtrString("Example Cloud Cost Query"),
						TitleSize:  datadog.PtrString("16"),
						TitleAlign: datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(),
						Type:       datadogV1.TIMESERIESWIDGETDEFINITIONTYPE_TIMESERIES,
						Requests: []datadogV1.TimeseriesWidgetRequest{
							{
								Formulas: []datadogV1.WidgetFormula{
									{
										Formula: "query1",
									},
								},
								Queries: []datadogV1.FormulaAndFunctionQueryDefinition{
									datadogV1.FormulaAndFunctionQueryDefinition{
										FormulaAndFunctionCloudCostQueryDefinition: &datadogV1.FormulaAndFunctionCloudCostQueryDefinition{
											DataSource: datadogV1.FORMULAANDFUNCTIONCLOUDCOSTDATASOURCE_CLOUD_COST,
											Name:       "query1",
											Query:      "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",
										}},
								},
								ResponseFormat: datadogV1.FORMULAANDFUNCTIONRESPONSEFORMAT_TIMESERIES.Ptr(),
								Style: &datadogV1.WidgetRequestStyle{
									Palette:   datadog.PtrString("dog_classic"),
									LineType:  datadogV1.WIDGETLINETYPE_SOLID.Ptr(),
									LineWidth: datadogV1.WIDGETLINEWIDTH_NORMAL.Ptr(),
								},
								DisplayType: datadogV1.WIDGETDISPLAYTYPE_BARS.Ptr(),
							},
						},
						Time: &datadogV1.WidgetTime{
							WidgetLegacyLiveSpan: &datadogV1.WidgetLegacyLiveSpan{}},
					}},
			},
		},
		LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.CreateDashboard(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreateDashboard`:\n%s\n", responseContent)
}

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query 
```
// Create a distribution widget using a histogram request containing a formulas and functions APM Stats query

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	body := datadogV1.Dashboard{
		Title:       "Example-Dashboard",
		Description: *datadog.NewNullableString(datadog.PtrString("")),
		Widgets: []datadogV1.Widget{
			{
				Definition: datadogV1.WidgetDefinition{
					DistributionWidgetDefinition: &datadogV1.DistributionWidgetDefinition{
						Title:      datadog.PtrString("APM Stats - Request latency HOP"),
						TitleSize:  datadog.PtrString("16"),
						TitleAlign: datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(),
						ShowLegend: datadog.PtrBool(false),
						Type:       datadogV1.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,
						Xaxis: &datadogV1.DistributionWidgetXAxis{
							Max:         datadog.PtrString("auto"),
							IncludeZero: datadog.PtrBool(true),
							Scale:       datadog.PtrString("linear"),
							Min:         datadog.PtrString("auto"),
						},
						Yaxis: &datadogV1.DistributionWidgetYAxis{
							Max:         datadog.PtrString("auto"),
							IncludeZero: datadog.PtrBool(true),
							Scale:       datadog.PtrString("linear"),
							Min:         datadog.PtrString("auto"),
						},
						Requests: []datadogV1.DistributionWidgetRequest{
							{
								Query: &datadogV1.DistributionWidgetHistogramRequestQuery{
									FormulaAndFunctionApmResourceStatsQueryDefinition: &datadogV1.FormulaAndFunctionApmResourceStatsQueryDefinition{
										PrimaryTagValue: datadog.PtrString("*"),
										Stat:            datadogV1.FORMULAANDFUNCTIONAPMRESOURCESTATNAME_LATENCY_DISTRIBUTION,
										DataSource:      datadogV1.FORMULAANDFUNCTIONAPMRESOURCESTATSDATASOURCE_APM_RESOURCE_STATS,
										Name:            "query1",
										Service:         "azure-bill-import",
										GroupBy: []string{
											"resource_name",
										},
										Env:            "staging",
										PrimaryTagName: datadog.PtrString("datacenter"),
										OperationName:  datadog.PtrString("universal.http.client"),
									}},
								RequestType: datadogV1.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),
								Style: &datadogV1.WidgetStyle{
									Palette: datadog.PtrString("dog_classic"),
								},
							},
						},
					}},
				Layout: &datadogV1.WidgetLayout{
					X:      8,
					Y:      0,
					Width:  4,
					Height: 2,
				},
			},
		},
		LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.CreateDashboard(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreateDashboard`:\n%s\n", responseContent)
}

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions events query 
```
// Create a distribution widget using a histogram request containing a formulas and functions events query

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	body := datadogV1.Dashboard{
		Title:       "Example-Dashboard",
		Description: *datadog.NewNullableString(datadog.PtrString("Example-Dashboard")),
		Widgets: []datadogV1.Widget{
			{
				Definition: datadogV1.WidgetDefinition{
					DistributionWidgetDefinition: &datadogV1.DistributionWidgetDefinition{
						Title:      datadog.PtrString("Events Platform - Request latency HOP"),
						TitleSize:  datadog.PtrString("16"),
						TitleAlign: datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(),
						ShowLegend: datadog.PtrBool(false),
						Type:       datadogV1.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,
						Xaxis: &datadogV1.DistributionWidgetXAxis{
							Max:         datadog.PtrString("auto"),
							IncludeZero: datadog.PtrBool(true),
							Scale:       datadog.PtrString("linear"),
							Min:         datadog.PtrString("auto"),
						},
						Yaxis: &datadogV1.DistributionWidgetYAxis{
							Max:         datadog.PtrString("auto"),
							IncludeZero: datadog.PtrBool(true),
							Scale:       datadog.PtrString("linear"),
							Min:         datadog.PtrString("auto"),
						},
						Requests: []datadogV1.DistributionWidgetRequest{
							{
								Query: &datadogV1.DistributionWidgetHistogramRequestQuery{
									FormulaAndFunctionEventQueryDefinition: &datadogV1.FormulaAndFunctionEventQueryDefinition{
										Search: &datadogV1.FormulaAndFunctionEventQueryDefinitionSearch{
											Query: "",
										},
										DataSource: datadogV1.FORMULAANDFUNCTIONEVENTSDATASOURCE_EVENTS,
										Compute: datadogV1.FormulaAndFunctionEventQueryDefinitionCompute{
											Metric:      datadog.PtrString("@duration"),
											Aggregation: datadogV1.FORMULAANDFUNCTIONEVENTAGGREGATION_MIN,
										},
										Name: "query1",
										Indexes: []string{
											"*",
										},
										GroupBy: []datadogV1.FormulaAndFunctionEventQueryGroupBy{},
									}},
								RequestType: datadogV1.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),
							},
						},
					}},
				Layout: &datadogV1.WidgetLayout{
					X:      0,
					Y:      0,
					Width:  4,
					Height: 2,
				},
			},
		},
		LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.CreateDashboard(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreateDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Clients deserialize a dashboard with a empty time object 
```
// Clients deserialize a dashboard with a empty time object

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.FormulaAndFunctionCloudCostDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionCloudCostQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinition;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;
import com.datadog.api.client.v1.model.TimeseriesWidgetRequest;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetDisplayType;
import com.datadog.api.client.v1.model.WidgetFormula;
import com.datadog.api.client.v1.model.WidgetLegacyLiveSpan;
import com.datadog.api.client.v1.model.WidgetLineType;
import com.datadog.api.client.v1.model.WidgetLineWidth;
import com.datadog.api.client.v1.model.WidgetRequestStyle;
import com.datadog.api.client.v1.model.WidgetTextAlign;
import com.datadog.api.client.v1.model.WidgetTime;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    Dashboard body =
        new Dashboard()
            .title("Example-Dashboard")
            .widgets(
                Collections.singletonList(
                    new Widget()
                        .definition(
                            new WidgetDefinition(
                                new TimeseriesWidgetDefinition()
                                    .title("Example Cloud Cost Query")
                                    .titleSize("16")
                                    .titleAlign(WidgetTextAlign.LEFT)
                                    .type(TimeseriesWidgetDefinitionType.TIMESERIES)
                                    .requests(
                                        Collections.singletonList(
                                            new TimeseriesWidgetRequest()
                                                .formulas(
                                                    Collections.singletonList(
                                                        new WidgetFormula().formula("query1")))
                                                .queries(
                                                    Collections.singletonList(
                                                        new FormulaAndFunctionQueryDefinition(
                                                            new FormulaAndFunctionCloudCostQueryDefinition()
                                                                .dataSource(
                                                                    FormulaAndFunctionCloudCostDataSource
                                                                        .CLOUD_COST)
                                                                .name("query1")
                                                                .query(
                                                                    "sum:aws.cost.amortized{*} by"
                                                                        + " {aws_product}.rollup(sum,"
                                                                        + " monthly)"))))
                                                .responseFormat(
                                                    FormulaAndFunctionResponseFormat.TIMESERIES)
                                                .style(
                                                    new WidgetRequestStyle()
                                                        .palette("dog_classic")
                                                        .lineType(WidgetLineType.SOLID)
                                                        .lineWidth(WidgetLineWidth.NORMAL))
                                                .displayType(WidgetDisplayType.BARS)))
                                    .time(new WidgetTime(new WidgetLegacyLiveSpan()))))))
            .layoutType(DashboardLayoutType.ORDERED);

    try {
      Dashboard result = apiInstance.createDashboard(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#createDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query 
```
// Create a distribution widget using a histogram request containing a formulas and functions APM
// Stats query

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
import com.datadog.api.client.v1.model.DistributionWidgetXAxis;
import com.datadog.api.client.v1.model.DistributionWidgetYAxis;
import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatName;
import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsQueryDefinition;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetLayout;
import com.datadog.api.client.v1.model.WidgetStyle;
import com.datadog.api.client.v1.model.WidgetTextAlign;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    Dashboard body =
        new Dashboard()
            .title("Example-Dashboard")
            .description("")
            .widgets(
                Collections.singletonList(
                    new Widget()
                        .definition(
                            new WidgetDefinition(
                                new DistributionWidgetDefinition()
                                    .title("APM Stats - Request latency HOP")
                                    .titleSize("16")
                                    .titleAlign(WidgetTextAlign.LEFT)
                                    .showLegend(false)
                                    .type(DistributionWidgetDefinitionType.DISTRIBUTION)
                                    .xaxis(
                                        new DistributionWidgetXAxis()
                                            .max("auto")
                                            .includeZero(true)
                                            .scale("linear")
                                            .min("auto"))
                                    .yaxis(
                                        new DistributionWidgetYAxis()
                                            .max("auto")
                                            .includeZero(true)
                                            .scale("linear")
                                            .min("auto"))
                                    .requests(
                                        Collections.singletonList(
                                            new DistributionWidgetRequest()
                                                .query(
                                                    new DistributionWidgetHistogramRequestQuery(
                                                        new FormulaAndFunctionApmResourceStatsQueryDefinition()
                                                            .primaryTagValue("*")
                                                            .stat(
                                                                FormulaAndFunctionApmResourceStatName
                                                                    .LATENCY_DISTRIBUTION)
                                                            .dataSource(
                                                                FormulaAndFunctionApmResourceStatsDataSource
                                                                    .APM_RESOURCE_STATS)
                                                            .name("query1")
                                                            .service("azure-bill-import")
                                                            .groupBy(
                                                                Collections.singletonList(
                                                                    "resource_name"))
                                                            .env("staging")
                                                            .primaryTagName("datacenter")
                                                            .operationName(
                                                                "universal.http.client")))
                                                .requestType(
                                                    DistributionWidgetHistogramRequestType
                                                        .HISTOGRAM)
                                                .style(new WidgetStyle().palette("dog_classic"))))))
                        .layout(new WidgetLayout().x(8L).y(0L).width(4L).height(2L))))
            .layoutType(DashboardLayoutType.ORDERED);

    try {
      Dashboard result = apiInstance.createDashboard(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#createDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions events query 
```
// Create a distribution widget using a histogram request containing a formulas and functions events
// query

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
import com.datadog.api.client.v1.model.DistributionWidgetXAxis;
import com.datadog.api.client.v1.model.DistributionWidgetYAxis;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetLayout;
import com.datadog.api.client.v1.model.WidgetTextAlign;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    Dashboard body =
        new Dashboard()
            .title("Example-Dashboard")
            .description("Example-Dashboard")
            .widgets(
                Collections.singletonList(
                    new Widget()
                        .definition(
                            new WidgetDefinition(
                                new DistributionWidgetDefinition()
                                    .title("Events Platform - Request latency HOP")
                                    .titleSize("16")
                                    .titleAlign(WidgetTextAlign.LEFT)
                                    .showLegend(false)
                                    .type(DistributionWidgetDefinitionType.DISTRIBUTION)
                                    .xaxis(
                                        new DistributionWidgetXAxis()
                                            .max("auto")
                                            .includeZero(true)
                                            .scale("linear")
                                            .min("auto"))
                                    .yaxis(
                                        new DistributionWidgetYAxis()
                                            .max("auto")
                                            .includeZero(true)
                                            .scale("linear")
                                            .min("auto"))
                                    .requests(
                                        Collections.singletonList(
                                            new DistributionWidgetRequest()
                                                .query(
                                                    new DistributionWidgetHistogramRequestQuery(
                                                        new FormulaAndFunctionEventQueryDefinition()
                                                            .search(
                                                                new FormulaAndFunctionEventQueryDefinitionSearch()
                                                                    .query(""))
                                                            .dataSource(
                                                                FormulaAndFunctionEventsDataSource
                                                                    .EVENTS)
                                                            .compute(
                                                                new FormulaAndFunctionEventQueryDefinitionCompute()
                                                                    .metric("@duration")
                                                                    .aggregation(
                                                                        FormulaAndFunctionEventAggregation
                                                                            .MIN))
                                                            .name("query1")
                                                            .indexes(
                                                                Collections.singletonList("*"))))
                                                .requestType(
                                                    DistributionWidgetHistogramRequestType
                                                        .HISTOGRAM)))))
                        .layout(new WidgetLayout().x(0L).y(0L).width(4L).height(2L))))
            .layoutType(DashboardLayoutType.ORDERED);

    try {
      Dashboard result = apiInstance.createDashboard(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#createDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Create a new dashboard returns "OK" response
```
from datadog import initialize, api

options = {
    'api_key': '<DATADOG_API_KEY>',
    'app_key': '<DATADOG_APPLICATION_KEY>'
}

initialize(**options)

title = 'Average Memory Free Shell'
widgets = [{
    'definition': {
        'type': 'timeseries',
        'requests': [
            {'q': 'avg:system.mem.free{*}'}
        ],
        'title': 'Average Memory Free'
    }
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = True
notify_list = ['user@domain.com']
template_variables = [{
    'name': 'host1',
    'prefix': 'host',
    'default': 'my-host'
}]

saved_views = [{
    'name': 'Saved views for hostname 2',
    'template_variables': [{'name': 'host', 'value': '<HOSTNAME_2>'}]}
]

api.Dashboard.create(title=title,
                     widgets=widgets,
                     layout_type=layout_type,
                     description=description,
                     is_read_only=is_read_only,
                     notify_list=notify_list,
                     template_variables=template_variables,
                     template_variable_presets=saved_view)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"


```

#####  Clients deserialize a dashboard with a empty time object 
```
"""
Clients deserialize a dashboard with a empty time object
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.formula_and_function_cloud_cost_data_source import (
    FormulaAndFunctionCloudCostDataSource,
)
from datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition import (
    FormulaAndFunctionCloudCostQueryDefinition,
)
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition
from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType
from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType
from datadog_api_client.v1.model.widget_formula import WidgetFormula
from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
from datadog_api_client.v1.model.widget_line_type import WidgetLineType
from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth
from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign

body = Dashboard(
    title="Example-Dashboard",
    widgets=[
        Widget(
            definition=TimeseriesWidgetDefinition(
                title="Example Cloud Cost Query",
                title_size="16",
                title_align=WidgetTextAlign.LEFT,
                type=TimeseriesWidgetDefinitionType.TIMESERIES,
                requests=[
                    TimeseriesWidgetRequest(
                        formulas=[
                            WidgetFormula(
                                formula="query1",
                            ),
                        ],
                        queries=[
                            FormulaAndFunctionCloudCostQueryDefinition(
                                data_source=FormulaAndFunctionCloudCostDataSource.CLOUD_COST,
                                name="query1",
                                query="sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",
                            ),
                        ],
                        response_format=FormulaAndFunctionResponseFormat.TIMESERIES,
                        style=WidgetRequestStyle(
                            palette="dog_classic",
                            line_type=WidgetLineType.SOLID,
                            line_width=WidgetLineWidth.NORMAL,
                        ),
                        display_type=WidgetDisplayType.BARS,
                    ),
                ],
                time=WidgetLegacyLiveSpan(),
            ),
        ),
    ],
    layout_type=DashboardLayoutType.ORDERED,
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.create_dashboard(body=body)

    print(response)

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query 
```
"""
Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition
from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType
from datadog_api_client.v1.model.distribution_widget_histogram_request_type import (
    DistributionWidgetHistogramRequestType,
)
from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest
from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis
from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis
from datadog_api_client.v1.model.formula_and_function_apm_resource_stat_name import (
    FormulaAndFunctionApmResourceStatName,
)
from datadog_api_client.v1.model.formula_and_function_apm_resource_stats_data_source import (
    FormulaAndFunctionApmResourceStatsDataSource,
)
from datadog_api_client.v1.model.formula_and_function_apm_resource_stats_query_definition import (
    FormulaAndFunctionApmResourceStatsQueryDefinition,
)
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_layout import WidgetLayout
from datadog_api_client.v1.model.widget_style import WidgetStyle
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign

body = Dashboard(
    title="Example-Dashboard",
    description="",
    widgets=[
        Widget(
            definition=DistributionWidgetDefinition(
                title="APM Stats - Request latency HOP",
                title_size="16",
                title_align=WidgetTextAlign.LEFT,
                show_legend=False,
                type=DistributionWidgetDefinitionType.DISTRIBUTION,
                xaxis=DistributionWidgetXAxis(
                    max="auto",
                    include_zero=True,
                    scale="linear",
                    min="auto",
                ),
                yaxis=DistributionWidgetYAxis(
                    max="auto",
                    include_zero=True,
                    scale="linear",
                    min="auto",
                ),
                requests=[
                    DistributionWidgetRequest(
                        query=FormulaAndFunctionApmResourceStatsQueryDefinition(
                            primary_tag_value="*",
                            stat=FormulaAndFunctionApmResourceStatName.LATENCY_DISTRIBUTION,
                            data_source=FormulaAndFunctionApmResourceStatsDataSource.APM_RESOURCE_STATS,
                            name="query1",
                            service="azure-bill-import",
                            group_by=[
                                "resource_name",
                            ],
                            env="staging",
                            primary_tag_name="datacenter",
                            operation_name="universal.http.client",
                        ),
                        request_type=DistributionWidgetHistogramRequestType.HISTOGRAM,
                        style=WidgetStyle(
                            palette="dog_classic",
                        ),
                    ),
                ],
            ),
            layout=WidgetLayout(
                x=8,
                y=0,
                width=4,
                height=2,
            ),
        ),
    ],
    layout_type=DashboardLayoutType.ORDERED,
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.create_dashboard(body=body)

    print(response)

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions events query 
```
"""
Create a distribution widget using a histogram request containing a formulas and functions events query
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition
from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType
from datadog_api_client.v1.model.distribution_widget_histogram_request_type import (
    DistributionWidgetHistogramRequestType,
)
from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest
from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis
from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis
from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation
from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
    FormulaAndFunctionEventQueryDefinition,
)
from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
    FormulaAndFunctionEventQueryDefinitionCompute,
)
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
    FormulaAndFunctionEventQueryDefinitionSearch,
)
from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_layout import WidgetLayout
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign

body = Dashboard(
    title="Example-Dashboard",
    description="Example-Dashboard",
    widgets=[
        Widget(
            definition=DistributionWidgetDefinition(
                title="Events Platform - Request latency HOP",
                title_size="16",
                title_align=WidgetTextAlign.LEFT,
                show_legend=False,
                type=DistributionWidgetDefinitionType.DISTRIBUTION,
                xaxis=DistributionWidgetXAxis(
                    max="auto",
                    include_zero=True,
                    scale="linear",
                    min="auto",
                ),
                yaxis=DistributionWidgetYAxis(
                    max="auto",
                    include_zero=True,
                    scale="linear",
                    min="auto",
                ),
                requests=[
                    DistributionWidgetRequest(
                        query=FormulaAndFunctionEventQueryDefinition(
                            search=FormulaAndFunctionEventQueryDefinitionSearch(
                                query="",
                            ),
                            data_source=FormulaAndFunctionEventsDataSource.EVENTS,
                            compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                metric="@duration",
                                aggregation=FormulaAndFunctionEventAggregation.MIN,
                            ),
                            name="query1",
                            indexes=[
                                "*",
                            ],
                            group_by=[],
                        ),
                        request_type=DistributionWidgetHistogramRequestType.HISTOGRAM,
                    ),
                ],
            ),
            layout=WidgetLayout(
                x=0,
                y=0,
                width=4,
                height=2,
            ),
        ),
    ],
    layout_type=DashboardLayoutType.ORDERED,
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.create_dashboard(body=body)

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Create a new dashboard returns "OK" response
```
require 'rubygems'
require 'dogapi'

api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'

dog = Dogapi::Client.new(api_key, app_key)

# Create a dashboard.
title = 'Average Memory Free Shell'
widgets = [{
    'definition': {
        'type' => 'timeseries',
        'requests' => [
            {'q' => 'avg:system.mem.free{*}'}
        ],
        'title' => 'Average Memory Free'
    }
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = true
notify_list = ['user@domain.com']
template_variables = [{
    'name' => 'host',
    'prefix' => 'host',
    'default' => '<HOSTNAME_1>'
}]

saved_view = [{
  'name': 'Saved views for hostname 2',
  'template_variables': [{'name': 'host', 'value': '<HOSTNAME_2>'}]}
  ]

dog.create_board(title, widgets, layout_type, {
    :description => description,
    :is_read_only => is_read_only,
    :notify_list => notify_list,
    :template_variables => template_variables,
    :template_variable_presets => saved_view
    })

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Clients deserialize a dashboard with a empty time object 
```
# Clients deserialize a dashboard with a empty time object

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

body = DatadogAPIClient::V1::Dashboard.new({
  title: "Example-Dashboard",
  widgets: [
    DatadogAPIClient::V1::Widget.new({
      definition: DatadogAPIClient::V1::TimeseriesWidgetDefinition.new({
        title: "Example Cloud Cost Query",
        title_size: "16",
        title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT,
        type: DatadogAPIClient::V1::TimeseriesWidgetDefinitionType::TIMESERIES,
        requests: [
          DatadogAPIClient::V1::TimeseriesWidgetRequest.new({
            formulas: [
              DatadogAPIClient::V1::WidgetFormula.new({
                formula: "query1",
              }),
            ],
            queries: [
              DatadogAPIClient::V1::FormulaAndFunctionCloudCostQueryDefinition.new({
                data_source: DatadogAPIClient::V1::FormulaAndFunctionCloudCostDataSource::CLOUD_COST,
                name: "query1",
                query: "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",
              }),
            ],
            response_format: DatadogAPIClient::V1::FormulaAndFunctionResponseFormat::TIMESERIES,
            style: DatadogAPIClient::V1::WidgetRequestStyle.new({
              palette: "dog_classic",
              line_type: DatadogAPIClient::V1::WidgetLineType::SOLID,
              line_width: DatadogAPIClient::V1::WidgetLineWidth::NORMAL,
            }),
            display_type: DatadogAPIClient::V1::WidgetDisplayType::BARS,
          }),
        ],
        time: DatadogAPIClient::V1::WidgetLegacyLiveSpan.new({}),
      }),
    }),
  ],
  layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
})
p api_instance.create_dashboard(body)

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query 
```
# Create a distribution widget using a histogram request containing a formulas and functions APM Stats query

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

body = DatadogAPIClient::V1::Dashboard.new({
  title: "Example-Dashboard",
  description: "",
  widgets: [
    DatadogAPIClient::V1::Widget.new({
      definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({
        title: "APM Stats - Request latency HOP",
        title_size: "16",
        title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT,
        show_legend: false,
        type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,
        xaxis: DatadogAPIClient::V1::DistributionWidgetXAxis.new({
          max: "auto",
          include_zero: true,
          scale: "linear",
          min: "auto",
        }),
        yaxis: DatadogAPIClient::V1::DistributionWidgetYAxis.new({
          max: "auto",
          include_zero: true,
          scale: "linear",
          min: "auto",
        }),
        requests: [
          DatadogAPIClient::V1::DistributionWidgetRequest.new({
            query: DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsQueryDefinition.new({
              primary_tag_value: "*",
              stat: DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatName::LATENCY_DISTRIBUTION,
              data_source: DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsDataSource::APM_RESOURCE_STATS,
              name: "query1",
              service: "azure-bill-import",
              group_by: [
                "resource_name",
              ],
              env: "staging",
              primary_tag_name: "datacenter",
              operation_name: "universal.http.client",
            }),
            request_type: DatadogAPIClient::V1::DistributionWidgetHistogramRequestType::HISTOGRAM,
            style: DatadogAPIClient::V1::WidgetStyle.new({
              palette: "dog_classic",
            }),
          }),
        ],
      }),
      layout: DatadogAPIClient::V1::WidgetLayout.new({
        x: 8,
        y: 0,
        width: 4,
        height: 2,
      }),
    }),
  ],
  layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
})
p api_instance.create_dashboard(body)

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions events query 
```
# Create a distribution widget using a histogram request containing a formulas and functions events query

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

body = DatadogAPIClient::V1::Dashboard.new({
  title: "Example-Dashboard",
  description: "Example-Dashboard",
  widgets: [
    DatadogAPIClient::V1::Widget.new({
      definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({
        title: "Events Platform - Request latency HOP",
        title_size: "16",
        title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT,
        show_legend: false,
        type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,
        xaxis: DatadogAPIClient::V1::DistributionWidgetXAxis.new({
          max: "auto",
          include_zero: true,
          scale: "linear",
          min: "auto",
        }),
        yaxis: DatadogAPIClient::V1::DistributionWidgetYAxis.new({
          max: "auto",
          include_zero: true,
          scale: "linear",
          min: "auto",
        }),
        requests: [
          DatadogAPIClient::V1::DistributionWidgetRequest.new({
            query: DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinition.new({
              search: DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionSearch.new({
                query: "",
              }),
              data_source: DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource::EVENTS,
              compute: DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionCompute.new({
                metric: "@duration",
                aggregation: DatadogAPIClient::V1::FormulaAndFunctionEventAggregation::MIN,
              }),
              name: "query1",
              indexes: [
                "*",
              ],
              group_by: [],
            }),
            request_type: DatadogAPIClient::V1::DistributionWidgetHistogramRequestType::HISTOGRAM,
          }),
        ],
      }),
      layout: DatadogAPIClient::V1::WidgetLayout.new({
        x: 0,
        y: 0,
        width: 4,
        height: 2,
      }),
    }),
  ],
  layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
})
p api_instance.create_dashboard(body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Clients deserialize a dashboard with a empty time object 
```
// Clients deserialize a dashboard with a empty time object
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::Dashboard;
use datadog_api_client::datadogV1::model::DashboardLayoutType;
use datadog_api_client::datadogV1::model::FormulaAndFunctionCloudCostDataSource;
use datadog_api_client::datadogV1::model::FormulaAndFunctionCloudCostQueryDefinition;
use datadog_api_client::datadogV1::model::FormulaAndFunctionQueryDefinition;
use datadog_api_client::datadogV1::model::FormulaAndFunctionResponseFormat;
use datadog_api_client::datadogV1::model::TimeseriesWidgetDefinition;
use datadog_api_client::datadogV1::model::TimeseriesWidgetDefinitionType;
use datadog_api_client::datadogV1::model::TimeseriesWidgetRequest;
use datadog_api_client::datadogV1::model::Widget;
use datadog_api_client::datadogV1::model::WidgetDefinition;
use datadog_api_client::datadogV1::model::WidgetDisplayType;
use datadog_api_client::datadogV1::model::WidgetFormula;
use datadog_api_client::datadogV1::model::WidgetLegacyLiveSpan;
use datadog_api_client::datadogV1::model::WidgetLineType;
use datadog_api_client::datadogV1::model::WidgetLineWidth;
use datadog_api_client::datadogV1::model::WidgetRequestStyle;
use datadog_api_client::datadogV1::model::WidgetTextAlign;
use datadog_api_client::datadogV1::model::WidgetTime;

#[tokio::main]
async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::TimeseriesWidgetDefinition(
                        Box::new(
                            TimeseriesWidgetDefinition::new(
                                vec![
                                    TimeseriesWidgetRequest::new()
                                        .display_type(WidgetDisplayType::BARS)
                                        .formulas(vec![WidgetFormula::new("query1".to_string())])
                                        .queries(
                                            vec![
                                                FormulaAndFunctionQueryDefinition
                                                ::FormulaAndFunctionCloudCostQueryDefinition(
                                                    Box::new(
                                                        FormulaAndFunctionCloudCostQueryDefinition::new(
                                                            FormulaAndFunctionCloudCostDataSource::CLOUD_COST,
                                                            "query1".to_string(),
                                                            "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)".to_string(),
                                                        ),
                                                    ),
                                                )
                                            ],
                                        )
                                        .response_format(FormulaAndFunctionResponseFormat::TIMESERIES)
                                        .style(
                                            WidgetRequestStyle::new()
                                                .line_type(WidgetLineType::SOLID)
                                                .line_width(WidgetLineWidth::NORMAL)
                                                .palette("dog_classic".to_string()),
                                        )
                                ],
                                TimeseriesWidgetDefinitionType::TIMESERIES,
                            )
                                .time(WidgetTime::WidgetLegacyLiveSpan(Box::new(WidgetLegacyLiveSpan::new())))
                                .title("Example Cloud Cost Query".to_string())
                                .title_align(WidgetTextAlign::LEFT)
                                .title_size("16".to_string()),
                        ),
                    ),
                )
            ],
        );
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query 
```
// Create a distribution widget using a histogram request containing a formulas
// and functions APM Stats query
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::Dashboard;
use datadog_api_client::datadogV1::model::DashboardLayoutType;
use datadog_api_client::datadogV1::model::DistributionWidgetDefinition;
use datadog_api_client::datadogV1::model::DistributionWidgetDefinitionType;
use datadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestQuery;
use datadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestType;
use datadog_api_client::datadogV1::model::DistributionWidgetRequest;
use datadog_api_client::datadogV1::model::DistributionWidgetXAxis;
use datadog_api_client::datadogV1::model::DistributionWidgetYAxis;
use datadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatName;
use datadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatsDataSource;
use datadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatsQueryDefinition;
use datadog_api_client::datadogV1::model::Widget;
use datadog_api_client::datadogV1::model::WidgetDefinition;
use datadog_api_client::datadogV1::model::WidgetLayout;
use datadog_api_client::datadogV1::model::WidgetStyle;
use datadog_api_client::datadogV1::model::WidgetTextAlign;

#[tokio::main]
async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::DistributionWidgetDefinition(
                        Box::new(
                            DistributionWidgetDefinition::new(
                                vec![
                                    DistributionWidgetRequest::new()
                                        .query(
                                            DistributionWidgetHistogramRequestQuery
                                            ::FormulaAndFunctionApmResourceStatsQueryDefinition(
                                                Box::new(
                                                    FormulaAndFunctionApmResourceStatsQueryDefinition::new(
                                                        FormulaAndFunctionApmResourceStatsDataSource
                                                        ::APM_RESOURCE_STATS,
                                                        "staging".to_string(),
                                                        "query1".to_string(),
                                                        "azure-bill-import".to_string(),
                                                        FormulaAndFunctionApmResourceStatName::LATENCY_DISTRIBUTION,
                                                    )
                                                        .group_by(vec!["resource_name".to_string()])
                                                        .operation_name("universal.http.client".to_string())
                                                        .primary_tag_name("datacenter".to_string())
                                                        .primary_tag_value("*".to_string()),
                                                ),
                                            ),
                                        )
                                        .request_type(DistributionWidgetHistogramRequestType::HISTOGRAM)
                                        .style(WidgetStyle::new().palette("dog_classic".to_string()))
                                ],
                                DistributionWidgetDefinitionType::DISTRIBUTION,
                            )
                                .show_legend(false)
                                .title("APM Stats - Request latency HOP".to_string())
                                .title_align(WidgetTextAlign::LEFT)
                                .title_size("16".to_string())
                                .xaxis(
                                    DistributionWidgetXAxis::new()
                                        .include_zero(true)
                                        .max("auto".to_string())
                                        .min("auto".to_string())
                                        .scale("linear".to_string()),
                                )
                                .yaxis(
                                    DistributionWidgetYAxis::new()
                                        .include_zero(true)
                                        .max("auto".to_string())
                                        .min("auto".to_string())
                                        .scale("linear".to_string()),
                                ),
                        ),
                    ),
                ).layout(WidgetLayout::new(2, 4, 8, 0))
            ],
        ).description(Some("".to_string()));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions events query 
```
// Create a distribution widget using a histogram request containing a formulas
// and functions events query
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::Dashboard;
use datadog_api_client::datadogV1::model::DashboardLayoutType;
use datadog_api_client::datadogV1::model::DistributionWidgetDefinition;
use datadog_api_client::datadogV1::model::DistributionWidgetDefinitionType;
use datadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestQuery;
use datadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestType;
use datadog_api_client::datadogV1::model::DistributionWidgetRequest;
use datadog_api_client::datadogV1::model::DistributionWidgetXAxis;
use datadog_api_client::datadogV1::model::DistributionWidgetYAxis;
use datadog_api_client::datadogV1::model::FormulaAndFunctionEventAggregation;
use datadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinition;
use datadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinitionCompute;
use datadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinitionSearch;
use datadog_api_client::datadogV1::model::FormulaAndFunctionEventsDataSource;
use datadog_api_client::datadogV1::model::Widget;
use datadog_api_client::datadogV1::model::WidgetDefinition;
use datadog_api_client::datadogV1::model::WidgetLayout;
use datadog_api_client::datadogV1::model::WidgetTextAlign;

#[tokio::main]
async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::DistributionWidgetDefinition(
                        Box::new(
                            DistributionWidgetDefinition::new(
                                vec![
                                    DistributionWidgetRequest::new()
                                        .query(
                                            DistributionWidgetHistogramRequestQuery
                                            ::FormulaAndFunctionEventQueryDefinition(
                                                Box::new(
                                                    FormulaAndFunctionEventQueryDefinition::new(
                                                        FormulaAndFunctionEventQueryDefinitionCompute::new(
                                                            FormulaAndFunctionEventAggregation::MIN,
                                                        ).metric("@duration".to_string()),
                                                        FormulaAndFunctionEventsDataSource::EVENTS,
                                                        "query1".to_string(),
                                                    )
                                                        .group_by(vec![])
                                                        .indexes(vec!["*".to_string()])
                                                        .search(
                                                            FormulaAndFunctionEventQueryDefinitionSearch::new(
                                                                "".to_string(),
                                                            ),
                                                        ),
                                                ),
                                            ),
                                        )
                                        .request_type(DistributionWidgetHistogramRequestType::HISTOGRAM)
                                ],
                                DistributionWidgetDefinitionType::DISTRIBUTION,
                            )
                                .show_legend(false)
                                .title("Events Platform - Request latency HOP".to_string())
                                .title_align(WidgetTextAlign::LEFT)
                                .title_size("16".to_string())
                                .xaxis(
                                    DistributionWidgetXAxis::new()
                                        .include_zero(true)
                                        .max("auto".to_string())
                                        .min("auto".to_string())
                                        .scale("linear".to_string()),
                                )
                                .yaxis(
                                    DistributionWidgetYAxis::new()
                                        .include_zero(true)
                                        .max("auto".to_string())
                                        .min("auto".to_string())
                                        .scale("linear".to_string()),
                                ),
                        ),
                    ),
                ).layout(WidgetLayout::new(2, 4, 0, 0))
            ],
        ).description(Some("Example-Dashboard".to_string()));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Clients deserialize a dashboard with a empty time object 
```
/**
 * Clients deserialize a dashboard with a empty time object
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

const params: v1.DashboardsApiCreateDashboardRequest = {
  body: {
    title: "Example-Dashboard",
    widgets: [
      {
        definition: {
          title: "Example Cloud Cost Query",
          titleSize: "16",
          titleAlign: "left",
          type: "timeseries",
          requests: [
            {
              formulas: [
                {
                  formula: "query1",
                },
              ],
              queries: [
                {
                  dataSource: "cloud_cost",
                  name: "query1",
                  query:
                    "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",
                },
              ],
              responseFormat: "timeseries",
              style: {
                palette: "dog_classic",
                lineType: "solid",
                lineWidth: "normal",
              },
              displayType: "bars",
            },
          ],
          time: {},
        },
      },
    ],
    layoutType: "ordered",
  },
};

apiInstance
  .createDashboard(params)
  .then((data: v1.Dashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions APM Stats query 
```
/**
 * Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

const params: v1.DashboardsApiCreateDashboardRequest = {
  body: {
    title: "Example-Dashboard",
    description: "",
    widgets: [
      {
        definition: {
          title: "APM Stats - Request latency HOP",
          titleSize: "16",
          titleAlign: "left",
          showLegend: false,
          type: "distribution",
          xaxis: {
            max: "auto",
            includeZero: true,
            scale: "linear",
            min: "auto",
          },
          yaxis: {
            max: "auto",
            includeZero: true,
            scale: "linear",
            min: "auto",
          },
          requests: [
            {
              query: {
                primaryTagValue: "*",
                stat: "latency_distribution",
                dataSource: "apm_resource_stats",
                name: "query1",
                service: "azure-bill-import",
                groupBy: ["resource_name"],
                env: "staging",
                primaryTagName: "datacenter",
                operationName: "universal.http.client",
              },
              requestType: "histogram",
              style: {
                palette: "dog_classic",
              },
            },
          ],
        },
        layout: {
          x: 8,
          y: 0,
          width: 4,
          height: 2,
        },
      },
    ],
    layoutType: "ordered",
  },
};

apiInstance
  .createDashboard(params)
  .then((data: v1.Dashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#####  Create a distribution widget using a histogram request containing a formulas and functions events query 
```
/**
 * Create a distribution widget using a histogram request containing a formulas and functions events query
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

const params: v1.DashboardsApiCreateDashboardRequest = {
  body: {
    title: "Example-Dashboard",
    description: "Example-Dashboard",
    widgets: [
      {
        definition: {
          title: "Events Platform - Request latency HOP",
          titleSize: "16",
          titleAlign: "left",
          showLegend: false,
          type: "distribution",
          xaxis: {
            max: "auto",
            includeZero: true,
            scale: "linear",
            min: "auto",
          },
          yaxis: {
            max: "auto",
            includeZero: true,
            scale: "linear",
            min: "auto",
          },
          requests: [
            {
              query: {
                search: {
                  query: "",
                },
                dataSource: "events",
                compute: {
                  metric: "@duration",
                  aggregation: "min",
                },
                name: "query1",
                indexes: ["*"],
                groupBy: [],
              },
              requestType: "histogram",
            },
          ],
        },
        layout: {
          x: 0,
          y: 0,
          width: 4,
          height: 2,
        },
      },
    ],
    layoutType: "ordered",
  },
};

apiInstance
  .createDashboard(params)
  .then((data: v1.Dashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Get a dashboard](https://docs.datadoghq.com/api/latest/dashboards/#get-a-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#get-a-dashboard-v1)


GET https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id}
### Overview
Get a dashboard using the specified ID. This endpoint requires the `dashboards_read` permission.
OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
dashboard_id [_required_]
string
The ID of the dashboard.
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#GetDashboard-200-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#GetDashboard-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#GetDashboard-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#GetDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.
Field
Type
Description
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
**DEPRECATED** : Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
layout_type [_required_]
enum
Layout type of the dashboard. Allowed enum values: `ordered,free`
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Allowed enum values: `auto,fixed`
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
tags
[string]
List of team names representing ownership of a dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
**DEPRECATED** : (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`.
values
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`.
template_variables
[object]
List of template variables for this dashboard.
available_values
[string]
The list of values that the template variable drop-down is limited to.
default
string
**DEPRECATED** : (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
title [_required_]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [_required_]
[object]
List of widgets to display on the dashboard.
definition [_required_]
<oneOf>
[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).
Option 1
object
Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the alert graph widget. Allowed enum values: `alert_graph`
default: `alert_graph`
viz_type [_required_]
enum
Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist`
Option 2
object
Alert values are query values showing the current value of the metric in any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
precision
int64
Number of decimal to show. If not defined, will use the raw value.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of value in the widget.
type [_required_]
enum
Type of the alert value widget. Allowed enum values: `alert_value`
default: `alert_value`
unit
string
Unit to display with the value.
Option 3
object
The Change graph shows you the change in a value over the time period chosen.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
Option 4
object
Check status shows the current status or number of results for any check performed.
check [_required_]
string
Name of the check to use in the widget.
group
string
Group reporting a single check.
group_by
[string]
List of tag prefixes to group by in the case of a cluster check.
grouping [_required_]
enum
The kind of grouping to use. Allowed enum values: `check,cluster`
tags
[string]
List of tags used to filter the groups reporting a cluster check.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the check status widget. Allowed enum values: `check_status`
default: `check_status`
Option 5
object
The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
legend_size
string
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
<oneOf>
Query definition for Distribution Widget Histogram Request
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the distribution widget. Allowed enum values: `distribution`
default: `distribution`
xaxis
object
X Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
max
string
Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
num_buckets
int64
Number of value buckets to target, also known as the resolution of the value bins.
scale
string
Specifies the scale type. Possible values are `linear`.
default: `linear`
yaxis
object
Y Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
label
string
The label of the axis to display on the graph.
max
string
Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear` or `log`.
default: `linear`
Option 6
object
The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.
event_size
enum
Size to use to display an event. Allowed enum values: `s,l`
query [_required_]
string
Query to filter the event stream with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event stream widget. Allowed enum values: `event_stream`
default: `event_stream`
Option 7
object
The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.
query [_required_]
string
Query to filter the event timeline with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event timeline widget. Allowed enum values: `event_timeline`
default: `event_timeline`
Option 8
object
Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
color
string
Color of the text.
font_size
string
Size of the text.
text [_required_]
string
Text to display.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the free text widget. Allowed enum values: `free_text`
default: `free_text`
Option 9
object
The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
requests [_required_]
[object]
Request payload used to query items.
query [_required_]
object
Updated funnel widget.
data_source [_required_]
enum
Source from which to query items to display in the funnel. Allowed enum values: `rum`
default: `rum`
query_string [_required_]
string
The widget query.
steps [_required_]
[object]
List of funnel steps.
facet [_required_]
string
The facet of the step.
value [_required_]
string
The value of the step.
request_type [_required_]
enum
Widget request type. Allowed enum values: `funnel`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of funnel widget. Allowed enum values: `funnel`
default: `funnel`
Option 10
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
columns
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
conditional_formats
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
text_formats
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
match [_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
replace
<oneOf>
Replace rule for the table widget text format.
Option 1
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
Option 2
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
style [_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
view [_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
Option 11
object
The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the group title.
banner_img
string
URL of image to display as a banner for the group.
layout_type [_required_]
enum
Layout type of the group. Allowed enum values: `ordered`
show_title
boolean
Whether to show the title or not.
default: `true`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the group widget. Allowed enum values: `group`
default: `group`
widgets [_required_]
[object]
List of widget groups.
Option 12
object
The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of widget types.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The event query.
search [_required_]
string
The query being made on the event.
tags_execution [_required_]
string
The execution method for multi-value filters. Can be either and or or.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the heat map widget. Allowed enum values: `heatmap`
default: `heatmap`
xaxis
object
X Axis controls for the heat map widget.
num_buckets
int64
Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier).
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 13
object
The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group
[string]
List of tag prefixes to group by.
no_group_hosts
boolean
Whether to show the hosts that don’t fit in a group.
no_metric_hosts
boolean
Whether to show the hosts with no metrics.
node_type
enum
Which type of node to use in the map. Allowed enum values: `host,container`
notes
string
Notes on the title.
requests [_required_]
object
List of definitions.
fill
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
size
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
scope
[string]
List of tags used to filter the map.
style
object
The style to apply to the widget.
fill_max
string
Max value to use to color the map.
fill_min
string
Min value to use to color the map.
palette
string
Color palette to apply to the widget.
palette_flip
boolean
Whether to flip the palette tones.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the host map widget. Allowed enum values: `hostmap`
default: `hostmap`
Option 14
object
The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
type [_required_]
enum
Type of the iframe widget. Allowed enum values: `iframe`
default: `iframe`
url [_required_]
string
URL of the iframe.
Option 15
object
The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
has_background
boolean
Whether to display a background or not.
default: `true`
has_border
boolean
Whether to display a border or not.
default: `true`
horizontal_align
enum
Horizontal alignment. Allowed enum values: `center,left,right`
margin
enum
Size of the margins around the image. **Note** : `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large`
sizing
enum
How to size the image on the widget. The values are based on the image `object-fit` CSS properties. **Note** : `zoom`, `fit` and `center` values are deprecated. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center`
type [_required_]
enum
Type of the image widget. Allowed enum values: `image`
default: `image`
url [_required_]
string
URL of the image.
url_dark_theme
string
URL of the image in dark mode.
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 16
object
The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
requests [_required_]
[object]
Request payload used to query items.
columns [_required_]
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
query [_required_]
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format [_required_]
enum
Widget response format. Allowed enum values: `event_list`
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the list stream widget. Allowed enum values: `list_stream`
default: `list_stream`
Option 17
object
The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
columns
[string]
Which columns to display on the widget.
indexes
[string]
An array of index names to query in the stream. Use [] to query all indexes at once.
logset
string
**DEPRECATED** : ID of the log set to use.
message_display
enum
Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg`
query
string
Query to filter the log stream with.
show_date_column
boolean
Whether to show the date column or not
show_message_column
boolean
Whether to show the message column or not
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the log stream widget. Allowed enum values: `log_stream`
default: `log_stream`
Option 18
object
The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
color_preference
enum
Which color to use on the widget. Allowed enum values: `background,text`
count
int64
**DEPRECATED** : The number of monitors to display.
display_format
enum
What to display on the widget. Allowed enum values: `counts,countsAndList,list`
hide_zero_counts
boolean
Whether to show counts of 0 or not.
query [_required_]
string
Query to filter the monitors with.
show_last_triggered
boolean
Whether to show the time that has elapsed since the monitor/group triggered.
show_priority
boolean
Whether to show the priorities column.
sort
enum
Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc,status,desc,tags,asc,tags,desc,triggered,asc,triggered,desc,priority,asc,priority,desc`
start
int64
**DEPRECATED** : The start of the list. Typically 0.
summary_type
enum
Which summary type should be used. Allowed enum values: `monitors,groups,combined`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the monitor summary widget. Allowed enum values: `manage_status`
default: `manage_status`
Option 19
object
The notes and links widget is similar to free text widget, but allows for more formatting options.
background_color
string
Background color of the note.
content [_required_]
string
Content of the note.
font_size
string
Size of the text.
has_padding
boolean
Whether to add padding or not.
default: `true`
show_tick
boolean
Whether to show a tick or not.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
tick_edge
enum
Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top`
tick_pos
string
Where to position the tick on an edge.
type [_required_]
enum
Type of the note widget. Allowed enum values: `note`
default: `note`
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 20
object
The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the powerpack title.
banner_img
string
URL of image to display as a banner for the powerpack.
powerpack_id [_required_]
string
UUID of the associated powerpack.
show_title
boolean
Whether to show the title or not.
default: `true`
template_variables
object
Powerpack template variables.
controlled_by_powerpack
[object]
Template variables controlled at the powerpack level.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
controlled_externally
[object]
Template variables controlled by the external resource, such as the dashboard this powerpack is on.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
title
string
Title of the widget.
type [_required_]
enum
Type of the powerpack widget. Allowed enum values: `powerpack`
default: `powerpack`
Option 21
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
timeseries_background
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
Option 22
object
Run workflow is widget that allows you to run a workflow from a dashboard.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
inputs
[object]
Array of workflow inputs to map to dashboard template variables.
name [_required_]
string
Name of the workflow input.
value [_required_]
string
Dashboard template variable. Can be suffixed with '.value' or '.key'.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the run workflow widget. Allowed enum values: `run_workflow`
default: `run_workflow`
workflow_id [_required_]
string
Workflow id.
Option 23
object
Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
requests [_required_]
[object]
Array of one request object to display in the widget.
query [_required_]
object
Updated SLO List widget.
limit
int64
Maximum number of results to display in the table.
default: `100`
query_string [_required_]
string
Widget query.
sort
[object]
Options for sorting results.
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
request_type [_required_]
enum
Widget request type. Allowed enum values: `slo_list`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO List widget. Allowed enum values: `slo_list`
default: `slo_list`
Option 24
object
Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
additional_query_filters
string
Additional filters applied to the SLO query.
global_time_target
string
Defined global time target.
show_error_budget
boolean
Defined error budget.
slo_id
string
ID of the SLO displayed.
time_windows
[string]
Times being monitored.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO widget. Allowed enum values: `slo`
default: `slo`
view_mode
enum
Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both`
view_type [_required_]
string
Type of view displayed by the widget.
default: `detail`
Option 25
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
object
Widget definition.
table
object
Scatterplot request containing formulas and functions.
formulas
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
x
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
y
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
xaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 26
object
This widget displays a map of a service to all of the services that call it, and all of the services that it calls.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
filters [_required_]
[string]
Your environment and primary tag (or * if enabled for your account).
service [_required_]
string
The ID of the service you want to map.
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service map widget. Allowed enum values: `servicemap`
default: `servicemap`
Option 27
object
The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
display_format
enum
Number of columns to display. Allowed enum values: `one_column,two_column,three_column`
env [_required_]
string
APM environment.
service [_required_]
string
APM service.
show_breakdown
boolean
Whether to show the latency breakdown or not.
show_distribution
boolean
Whether to show the latency distribution or not.
show_errors
boolean
Whether to show the error metrics or not.
show_hits
boolean
Whether to show the hits metrics or not.
show_latency
boolean
Whether to show the latency metrics or not.
show_resource_list
boolean
Whether to show the resource list or not.
size_format
enum
Size of the widget. Allowed enum values: `small,medium,large`
span_name [_required_]
string
APM span name.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service summary widget. Allowed enum values: `trace_service`
default: `trace_service`
Option 28
object
The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service)
has_uniform_y_axes
boolean
Normalize y axes across graphs
size [_required_]
enum
Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg`
source_widget_definition [_required_]
<oneOf>
The original widget we are splitting on.
Option 1
object
The Change graph shows you the change in a value over the time period chosen.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
Option 2
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
columns
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
conditional_formats
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
text_formats
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
match [_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
replace
<oneOf>
Replace rule for the table widget text format.
Option 1
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
Option 2
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
style [_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
view [_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
Option 3
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
timeseries_background
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
Option 4
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
object
Widget definition.
table
object
Scatterplot request containing formulas and functions.
formulas
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
x
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
y
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
xaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 5
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
legend
<oneOf>
Configuration of the legend.
Option 1
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
Option 2
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
requests [_required_]
[object]
List of sunburst widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
Option 6
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
Option 7
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of timeseries widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
metadata
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
right_yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 8
object
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
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
List of top list widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
style
object
Style customization for a top list widget.
display
<oneOf>
Top list widget display options.
Option 1
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
Option 2
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
Option 9
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
requests [_required_]
[object]
List of treemap widget requests.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
split_config [_required_]
object
Encapsulates all user choices about how to split a graph.
limit [_required_]
int64
Maximum number of graphs to display in the widget.
sort [_required_]
object
Controls the order in which graphs appear in the split.
compute
object
Defines the metric and aggregation used as the sort value.
aggregation [_required_]
string
How to aggregate the sort metric for the purposes of ordering.
metric [_required_]
string
The metric to use for sorting graphs.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
split_dimensions [_required_]
[object]
The dimension(s) on which to split the graph
one_graph_per [_required_]
string
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
[array]
Manual selection of tags making split graph widget static
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the split graph widget Allowed enum values: `split_group`
default: `split_group`
Option 29
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
legend
<oneOf>
Configuration of the legend.
Option 1
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
Option 2
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
requests [_required_]
[object]
List of sunburst widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
Option 30
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
Option 31
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of timeseries widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
metadata
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
right_yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 32
object
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
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
List of top list widget requests.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
style
object
Style customization for a top list widget.
display
<oneOf>
Top list widget display options.
Option 1
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
Option 2
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
Option 33
object
This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
One or more Topology requests.
query
object
Query to service-based topology data sources like the service map or data streams.
data_source
enum
Name of the data source Allowed enum values: `data_streams,service_map`
filters
[string]
Your environment and primary tag (or * if enabled for your account).
service
string
Name of the service
request_type
enum
Widget request type. Allowed enum values: `topology`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the topology map widget. Allowed enum values: `topology_map`
default: `topology_map`
Option 34
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
requests [_required_]
[object]
List of treemap widget requests.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
id
int64
ID of the widget.
layout
object
The layout for a widget on a `free` or **new dashboard layout** dashboard.
height [_required_]
int64
The height of the widget. Should be a non-negative integer.
is_column_break
boolean
Whether the widget should be the first one on the second column in high density or not. **Note** : Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`.
width [_required_]
int64
The width of the widget. Should be a non-negative integer.
x [_required_]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [_required_]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
```
{
  "author_handle": "test@datadoghq.com",
  "author_name": "John Doe",
  "created_at": "2019-09-19T10:00:00.000Z",
  "description": "string",
  "id": "123-abc-456",
  "is_read_only": false,
  "layout_type": "ordered",
  "modified_at": "2019-09-19T10:00:00.000Z",
  "notify_list": [],
  "reflow_type": "string",
  "restricted_roles": [],
  "tags": [],
  "template_variable_presets": [
    {
      "name": "string",
      "template_variables": [
        {
          "name": "string",
          "value": "string",
          "values": []
        }
      ]
    }
  ],
  "template_variables": [
    {
      "available_values": [
        "my-host",
        "host1",
        "host2"
      ],
      "default": "my-host",
      "defaults": [
        "my-host-1",
        "my-host-2"
      ],
      "name": "host1",
      "prefix": "host",
      "type": "group"
    }
  ],
  "title": "",
  "url": "/dashboard/123-abc-456/example-dashboard-title",
  "widgets": [
    {
      "definition": {
        "requests": {
          "fill": {
            "q": "avg:system.cpu.user{*}"
          }
        },
        "type": "hostmap"
      },
      "id": "integer",
      "layout": {
        "height": 0,
        "is_column_break": false,
        "width": 0,
        "x": 0,
        "y": 0
      }
    }
  ]
}
```

Copy
Authentication Error
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Item Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)
  * [Ruby [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby-legacy)
  * [Python [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python-legacy)


#####  Get a dashboard
Copy
```
                  # Path parameters  
export dashboard_id="CHANGE_ME"  
# Curl command  
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"  

                
```

#####  Get a dashboard
```
"""
Get a dashboard returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.get_dashboard(
        dashboard_id=DASHBOARD_ID,
    )

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Get a dashboard
```
# Get a dashboard returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
p api_instance.get_dashboard(DASHBOARD_ID)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Get a dashboard
```
require 'rubygems'
require 'dogapi'

api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'

dog = Dogapi::Client.new(api_key, app_key)

dashboard_id = '<DASHBOARD_ID>'
dog.get_board(dashboard_id)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Get a dashboard
```
// Get a dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.GetDashboard(ctx, DashboardID)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.GetDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.GetDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Get a dashboard
```
// Get a dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    try {
      Dashboard result = apiInstance.getDashboard(DASHBOARD_ID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#getDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Get a dashboard
```
from datadog import initialize, api

options = {
    'api_key': '<DATADOG_API_KEY>',
    'app_key': '<DATADOG_APPLICATION_KEY>'
}

initialize(**options)

dashboard_id = '<DASHBOARD_ID>'

api.Dashboard.get(dashboard_id)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"


```

#####  Get a dashboard
```
// Get a dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.get_dashboard(dashboard_id.clone()).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Get a dashboard
```
/**
 * Get a dashboard returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiGetDashboardRequest = {
  dashboardId: DASHBOARD_ID,
};

apiInstance
  .getDashboard(params)
  .then((data: v1.Dashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Get all dashboards](https://docs.datadoghq.com/api/latest/dashboards/#get-all-dashboards)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#get-all-dashboards-v1)


GET https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.ap2.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
### Overview
Get all dashboards.
**Note** : This query will only return custom created or cloned dashboards. This query will not return preset dashboards.
This endpoint requires the `dashboards_read` permission.
OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Query Strings
Name
Type
Description
filter[shared]
boolean
When `true`, this query only returns shared custom created or cloned dashboards.
filter[deleted]
boolean
When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`.
count
integer
The maximum number of dashboards returned in the list.
start
integer
The specific offset to use as the beginning of the returned response.
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#ListDashboards-200-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#ListDashboards-403-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#ListDashboards-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Dashboard summary response.
Field
Type
Description
dashboards
[object]
List of dashboard definitions.
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
Dashboard identifier.
is_read_only
boolean
**DEPRECATED** : Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
layout_type
enum
Layout type of the dashboard. Allowed enum values: `ordered,free`
modified_at
date-time
Modification date of the dashboard.
title
string
Title of the dashboard.
url
string
URL of the dashboard.
```
{
  "dashboards": [
    {
      "author_handle": "string",
      "created_at": "2019-09-19T10:00:00.000Z",
      "description": "string",
      "id": "string",
      "is_read_only": false,
      "layout_type": "ordered",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "title": "string",
      "url": "string"
    }
  ]
}
```

Copy
Authentication Error
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)
  * [Ruby [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby-legacy)
  * [Python [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python-legacy)


#####  Get all dashboards
Copy
```
                  # Curl command  
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"  

                
```

#####  Get all dashboards
```
"""
Get all dashboards returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.list_dashboards(
        filter_shared=False,
    )

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Get all dashboards
```
# Get all dashboards returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
opts = {
  filter_shared: false,
}
p api_instance.list_dashboards(opts)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Get all dashboards
```
require 'rubygems'
require 'dogapi'

api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'

dog = Dogapi::Client.new(api_key, app_key)

dog.get_all_boards()

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Get all dashboards
```
// Get all dashboards returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.ListDashboards(ctx, *datadogV1.NewListDashboardsOptionalParameters().WithFilterShared(false))

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.ListDashboards`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.ListDashboards`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Get all dashboards
```
// Get all dashboards returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters;
import com.datadog.api.client.v1.model.DashboardSummary;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    try {
      DashboardSummary result =
          apiInstance.listDashboards(new ListDashboardsOptionalParameters().filterShared(false));
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#listDashboards");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Get all dashboards
```
from datadog import initialize, api

options = {
    'api_key': '<DATADOG_API_KEY>',
    'app_key': '<DATADOG_APPLICATION_KEY>'
}

initialize(**options)

api.Dashboard.get_all()

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"


```

#####  Get all dashboards
```
// Get all dashboards returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::api_dashboards::ListDashboardsOptionalParams;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .list_dashboards(ListDashboardsOptionalParams::default().filter_shared(false))
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Get all dashboards
```
/**
 * Get all dashboards returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

const params: v1.DashboardsApiListDashboardsRequest = {
  filterShared: false,
};

apiInstance
  .listDashboards(params)
  .then((data: v1.DashboardSummary) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Update a dashboard](https://docs.datadoghq.com/api/latest/dashboards/#update-a-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#update-a-dashboard-v1)


PUT https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id}
### Overview
Update a dashboard using the specified ID. This endpoint requires the `dashboards_write` permission.
OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
dashboard_id [_required_]
string
The ID of the dashboard.
### Request
#### Body Data (required)
Update Dashboard request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Field
Type
Description
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
**DEPRECATED** : Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
layout_type [_required_]
enum
Layout type of the dashboard. Allowed enum values: `ordered,free`
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Allowed enum values: `auto,fixed`
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
tags
[string]
List of team names representing ownership of a dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
**DEPRECATED** : (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`.
values
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`.
template_variables
[object]
List of template variables for this dashboard.
available_values
[string]
The list of values that the template variable drop-down is limited to.
default
string
**DEPRECATED** : (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
title [_required_]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [_required_]
[object]
List of widgets to display on the dashboard.
definition [_required_]
<oneOf>
[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).
Option 1
object
Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the alert graph widget. Allowed enum values: `alert_graph`
default: `alert_graph`
viz_type [_required_]
enum
Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist`
Option 2
object
Alert values are query values showing the current value of the metric in any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
precision
int64
Number of decimal to show. If not defined, will use the raw value.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of value in the widget.
type [_required_]
enum
Type of the alert value widget. Allowed enum values: `alert_value`
default: `alert_value`
unit
string
Unit to display with the value.
Option 3
object
The Change graph shows you the change in a value over the time period chosen.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
Option 4
object
Check status shows the current status or number of results for any check performed.
check [_required_]
string
Name of the check to use in the widget.
group
string
Group reporting a single check.
group_by
[string]
List of tag prefixes to group by in the case of a cluster check.
grouping [_required_]
enum
The kind of grouping to use. Allowed enum values: `check,cluster`
tags
[string]
List of tags used to filter the groups reporting a cluster check.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the check status widget. Allowed enum values: `check_status`
default: `check_status`
Option 5
object
The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
legend_size
string
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
apm_stats_query
object
The APM stats query for table and distributions widgets.
columns
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
<oneOf>
Query definition for Distribution Widget Histogram Request
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the distribution widget. Allowed enum values: `distribution`
default: `distribution`
xaxis
object
X Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
max
string
Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
num_buckets
int64
Number of value buckets to target, also known as the resolution of the value bins.
scale
string
Specifies the scale type. Possible values are `linear`.
default: `linear`
yaxis
object
Y Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
label
string
The label of the axis to display on the graph.
max
string
Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear` or `log`.
default: `linear`
Option 6
object
The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.
event_size
enum
Size to use to display an event. Allowed enum values: `s,l`
query [_required_]
string
Query to filter the event stream with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event stream widget. Allowed enum values: `event_stream`
default: `event_stream`
Option 7
object
The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.
query [_required_]
string
Query to filter the event timeline with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event timeline widget. Allowed enum values: `event_timeline`
default: `event_timeline`
Option 8
object
Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
color
string
Color of the text.
font_size
string
Size of the text.
text [_required_]
string
Text to display.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the free text widget. Allowed enum values: `free_text`
default: `free_text`
Option 9
object
The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
requests [_required_]
[object]
Request payload used to query items.
query [_required_]
object
Updated funnel widget.
data_source [_required_]
enum
Source from which to query items to display in the funnel. Allowed enum values: `rum`
default: `rum`
query_string [_required_]
string
The widget query.
steps [_required_]
[object]
List of funnel steps.
facet [_required_]
string
The facet of the step.
value [_required_]
string
The value of the step.
request_type [_required_]
enum
Widget request type. Allowed enum values: `funnel`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of funnel widget. Allowed enum values: `funnel`
default: `funnel`
Option 10
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
requests [_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
columns
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
conditional_formats
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
sort
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
order_by
[ <oneOf>]
The array of items to sort the widget by in order.
Option 1
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
Option 2
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
style
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
text_formats
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
match [_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
replace
<oneOf>
Replace rule for the table widget text format.
Option 1
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
Option 2
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
style [_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
view [_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
Option 11
object
The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the group title.
banner_img
string
URL of image to display as a banner for the group.
layout_type [_required_]
enum
Layout type of the group. Allowed enum values: `ordered`
show_title
boolean
Whether to show the title or not.
default: `true`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the group widget. Allowed enum values: `group`
default: `group`
widgets [_required_]
[object]
List of widget groups.
Option 12
object
The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
events
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markers
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
requests [_required_]
[object]
List of widget types.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The event query.
search [_required_]
string
The query being made on the event.
tags_execution [_required_]
string
The execution method for multi-value filters. Can be either and or or.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
query
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
style
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the heat map widget. Allowed enum values: `heatmap`
default: `heatmap`
xaxis
object
X Axis controls for the heat map widget.
num_buckets
int64
Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier).
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
Option 13
object
The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group
[string]
List of tag prefixes to group by.
no_group_hosts
boolean
Whether to show the hosts that don’t fit in a group.
no_metric_hosts
boolean
Whether to show the hosts with no metrics.
node_type
enum
Which type of node to use in the map. Allowed enum values: `host,container`
notes
string
Notes on the title.
requests [_required_]
object
List of definitions.
fill
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
size
object
Updated host map.
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
scope
[string]
List of tags used to filter the map.
style
object
The style to apply to the widget.
fill_max
string
Max value to use to color the map.
fill_min
string
Min value to use to color the map.
palette
string
Color palette to apply to the widget.
palette_flip
boolean
Whether to flip the palette tones.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the host map widget. Allowed enum values: `hostmap`
default: `hostmap`
Option 14
object
The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
type [_required_]
enum
Type of the iframe widget. Allowed enum values: `iframe`
default: `iframe`
url [_required_]
string
URL of the iframe.
Option 15
object
The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
has_background
boolean
Whether to display a background or not.
default: `true`
has_border
boolean
Whether to display a border or not.
default: `true`
horizontal_align
enum
Horizontal alignment. Allowed enum values: `center,left,right`
margin
enum
Size of the margins around the image. **Note** : `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large`
sizing
enum
How to size the image on the widget. The values are based on the image `object-fit` CSS properties. **Note** : `zoom`, `fit` and `center` values are deprecated. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center`
type [_required_]
enum
Type of the image widget. Allowed enum values: `image`
default: `image`
url [_required_]
string
URL of the image.
url_dark_theme
string
URL of the image in dark mode.
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 16
object
The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
requests [_required_]
[object]
Request payload used to query items.
columns [_required_]
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
query [_required_]
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
compute
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
group_by
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format [_required_]
enum
Widget response format. Allowed enum values: `event_list`
show_legend
boolean
Whether or not to display the legend on this widget.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the list stream widget. Allowed enum values: `list_stream`
default: `list_stream`
Option 17
object
The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
columns
[string]
Which columns to display on the widget.
indexes
[string]
An array of index names to query in the stream. Use [] to query all indexes at once.
logset
string
**DEPRECATED** : ID of the log set to use.
message_display
enum
Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg`
query
string
Query to filter the log stream with.
show_date_column
boolean
Whether to show the date column or not
show_message_column
boolean
Whether to show the message column or not
sort
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the log stream widget. Allowed enum values: `log_stream`
default: `log_stream`
Option 18
object
The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
color_preference
enum
Which color to use on the widget. Allowed enum values: `background,text`
count
int64
**DEPRECATED** : The number of monitors to display.
display_format
enum
What to display on the widget. Allowed enum values: `counts,countsAndList,list`
hide_zero_counts
boolean
Whether to show counts of 0 or not.
query [_required_]
string
Query to filter the monitors with.
show_last_triggered
boolean
Whether to show the time that has elapsed since the monitor/group triggered.
show_priority
boolean
Whether to show the priorities column.
sort
enum
Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc,status,desc,tags,asc,tags,desc,triggered,asc,triggered,desc,priority,asc,priority,desc`
start
int64
**DEPRECATED** : The start of the list. Typically 0.
summary_type
enum
Which summary type should be used. Allowed enum values: `monitors,groups,combined`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the monitor summary widget. Allowed enum values: `manage_status`
default: `manage_status`
Option 19
object
The notes and links widget is similar to free text widget, but allows for more formatting options.
background_color
string
Background color of the note.
content [_required_]
string
Content of the note.
font_size
string
Size of the text.
has_padding
boolean
Whether to add padding or not.
default: `true`
show_tick
boolean
Whether to show a tick or not.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
tick_edge
enum
Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top`
tick_pos
string
Where to position the tick on an edge.
type [_required_]
enum
Type of the note widget. Allowed enum values: `note`
default: `note`
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
Option 20
object
The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the powerpack title.
banner_img
string
URL of image to display as a banner for the powerpack.
powerpack_id [_required_]
string
UUID of the associated powerpack.
show_title
boolean
Whether to show the title or not.
default: `true`
template_variables
object
Powerpack template variables.
controlled_by_powerpack
[object]
Template variables controlled at the powerpack level.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
controlled_externally
[object]
Template variables controlled by the external resource, such as the dashboard this powerpack is on.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
title
string
Title of the widget.
type [_required_]
enum
Type of the powerpack widget. Allowed enum values: `powerpack`
default: `powerpack`
Option 21
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
cell_display_mode_options
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
conditional_formats
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
number_format
object
Number format options for the widget.
unit
<oneOf>
Number format unit.
Option 1
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
Option 2
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
unit_scale
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
Option 2
object
A formula and functions events query.
compute [_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
group_by
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
search
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
Option 5
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
multi_compute
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed 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
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
timeseries_background
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
object
Run workflow is widget that allows you to run a workflow from a dashboard.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
[object]
Array of workflow inputs to map to dashboard template variables.
name [_required_]
string
Name of the workflow input.
value [_required_]
string
Dashboard template variable. Can be suffixed with '.value' or '.key'.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the run workflow widget. Allowed enum values: `run_workflow`
default: `run_workflow`
workflow_id [_required_]
string
Workflow id.
object
Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
_required_]
[object]
Array of one request object to display in the widget.
_required_]
object
Updated SLO List widget.
limit
int64
Maximum number of results to display in the table.
default: `100`
query_string [_required_]
string
Widget query.
[object]
Options for sorting results.
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
request_type [_required_]
enum
Widget request type. Allowed enum values: `slo_list`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO List widget. Allowed enum values: `slo_list`
default: `slo_list`
object
Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
additional_query_filters
string
Additional filters applied to the SLO query.
global_time_target
string
Defined global time target.
show_error_budget
boolean
Defined error budget.
slo_id
string
ID of the SLO displayed.
time_windows
[string]
Times being monitored.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO widget. Allowed enum values: `slo`
default: `slo`
view_mode
enum
Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both`
view_type [_required_]
string
Type of view displayed by the widget.
default: `detail`
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
object
Widget definition.
object
Scatterplot request containing formulas and functions.
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
This widget displays a map of a service to all of the services that call it, and all of the services that it calls.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
filters [_required_]
[string]
Your environment and primary tag (or * if enabled for your account).
service [_required_]
string
The ID of the service you want to map.
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service map widget. Allowed enum values: `servicemap`
default: `servicemap`
object
The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
display_format
enum
Number of columns to display. Allowed enum values: `one_column,two_column,three_column`
env [_required_]
string
APM environment.
service [_required_]
string
APM service.
show_breakdown
boolean
Whether to show the latency breakdown or not.
show_distribution
boolean
Whether to show the latency distribution or not.
show_errors
boolean
Whether to show the error metrics or not.
show_hits
boolean
Whether to show the hits metrics or not.
show_latency
boolean
Whether to show the latency metrics or not.
show_resource_list
boolean
Whether to show the resource list or not.
size_format
enum
Size of the widget. Allowed enum values: `small,medium,large`
span_name [_required_]
string
APM span name.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service summary widget. Allowed enum values: `trace_service`
default: `trace_service`
object
The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service)
has_uniform_y_axes
boolean
Normalize y axes across graphs
size [_required_]
enum
Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg`
_required_]
<oneOf>
The original widget we are splitting on.
object
The Change graph shows you the change in a value over the time period chosen.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
object
This visualization displays a series of values by country on a world map.
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
<oneOf>
Replace rule for the table widget text format.
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
object
Widget definition.
object
Scatterplot request containing formulas and functions.
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
<oneOf>
Configuration of the legend.
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
_required_]
[object]
List of sunburst widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Widget style definition.
palette
string
Color palette to apply to the widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The APM stats query for table and distributions widgets.
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
_required_]
[object]
List of timeseries widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
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.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
List of top list widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Style customization for a top list widget.
<oneOf>
Top list widget display options.
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
_required_]
[object]
List of treemap widget requests.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
_required_]
object
Encapsulates all user choices about how to split a graph.
limit [_required_]
int64
Maximum number of graphs to display in the widget.
_required_]
object
Controls the order in which graphs appear in the split.
object
Defines the metric and aggregation used as the sort value.
aggregation [_required_]
string
How to aggregate the sort metric for the purposes of ordering.
metric [_required_]
string
The metric to use for sorting graphs.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
_required_]
[object]
The dimension(s) on which to split the graph
one_graph_per [_required_]
string
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
[array]
Manual selection of tags making split graph widget static
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the split graph widget Allowed enum values: `split_group`
default: `split_group`
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
<oneOf>
Configuration of the legend.
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
_required_]
[object]
List of sunburst widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Widget style definition.
palette
string
Color palette to apply to the widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The APM stats query for table and distributions widgets.
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
_required_]
[object]
List of timeseries widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
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.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
List of top list widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Style customization for a top list widget.
<oneOf>
Top list widget display options.
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
object
This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
One or more Topology requests.
object
Query to service-based topology data sources like the service map or data streams.
data_source
enum
Name of the data source Allowed enum values: `data_streams,service_map`
filters
[string]
Your environment and primary tag (or * if enabled for your account).
service
string
Name of the service
request_type
enum
Widget request type. Allowed enum values: `topology`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the topology map widget. Allowed enum values: `topology_map`
default: `topology_map`
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
_required_]
[object]
List of treemap widget requests.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
id
int64
ID of the widget.
object
The layout for a widget on a `free` or **new dashboard layout** dashboard.
height [_required_]
int64
The height of the widget. Should be a non-negative integer.
is_column_break
boolean
Whether the widget should be the first one on the second column in high density or not. **Note** : Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`.
width [_required_]
int64
The width of the widget. Should be a non-negative integer.
x [_required_]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [_required_]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
#####  Update a dashboard returns "OK" response
```
{
  "layout_type": "ordered",
  "title": "Example-Dashboard with list_stream widget",
  "description": "Updated description",
  "widgets": [
    {
      "definition": {
        "type": "list_stream",
        "requests": [
          {
            "columns": [
              {
                "width": "auto",
                "field": "timestamp"
              }
            ],
            "query": {
              "data_source": "apm_issue_stream",
              "query_string": ""
            },
            "response_format": "event_list"
          }
        ]
      }
    }
  ]
}
```

Copy
#####  Update a dashboard with tags returns "OK" response
```
{
  "layout_type": "ordered",
  "title": "Example-Dashboard with list_stream widget",
  "description": "Updated description",
  "tags": [
    "team:foo",
    "team:bar"
  ],
  "widgets": [
    {
      "definition": {
        "type": "list_stream",
        "requests": [
          {
            "columns": [
              {
                "width": "auto",
                "field": "timestamp"
              }
            ],
            "query": {
              "data_source": "apm_issue_stream",
              "query_string": ""
            },
            "response_format": "event_list"
          }
        ]
      }
    }
  ]
}
```

Copy
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#UpdateDashboard-200-v1)
  * [400](https://docs.datadoghq.com/api/latest/dashboards/#UpdateDashboard-400-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#UpdateDashboard-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#UpdateDashboard-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#UpdateDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.
Expand All
Field
Type
Description
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
**DEPRECATED** : Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
layout_type [_required_]
enum
Layout type of the dashboard. Allowed enum values: `ordered,free`
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Allowed enum values: `auto,fixed`
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
tags
[string]
List of team names representing ownership of a dashboard.
[object]
Array of template variables saved views.
name
string
The name of the variable.
[object]
List of variables.
name
string
The name of the variable.
value
string
**DEPRECATED** : (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`.
values
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`.
[object]
List of template variables for this dashboard.
available_values
[string]
The list of values that the template variable drop-down is limited to.
default
string
**DEPRECATED** : (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
title [_required_]
string
Title of the dashboard.
url
string
The URL of the dashboard.
_required_]
[object]
List of widgets to display on the dashboard.
_required_]
<oneOf>
[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).
object
Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the alert graph widget. Allowed enum values: `alert_graph`
default: `alert_graph`
viz_type [_required_]
enum
Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist`
object
Alert values are query values showing the current value of the metric in any monitor defined on your system.
alert_id [_required_]
string
ID of the alert to use in the widget.
precision
int64
Number of decimal to show. If not defined, will use the raw value.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of value in the widget.
type [_required_]
enum
Type of the alert value widget. Allowed enum values: `alert_value`
default: `alert_value`
unit
string
Unit to display with the value.
object
The Change graph shows you the change in a value over the time period chosen.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
object
Check status shows the current status or number of results for any check performed.
check [_required_]
string
Name of the check to use in the widget.
group
string
Group reporting a single check.
group_by
[string]
List of tag prefixes to group by in the case of a cluster check.
grouping [_required_]
enum
The kind of grouping to use. Allowed enum values: `check,cluster`
tags
[string]
List of tags used to filter the groups reporting a cluster check.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the check status widget. Allowed enum values: `check_status`
default: `check_status`
object
The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
legend_size
string
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The APM stats query for table and distributions widgets.
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
<oneOf>
Query definition for Distribution Widget Histogram Request
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
**DEPRECATED** : (Deprecated) The widget legend was replaced by a tooltip and sidebar.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the distribution widget. Allowed enum values: `distribution`
default: `distribution`
object
X Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
max
string
Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
default: `auto`
num_buckets
int64
Number of value buckets to target, also known as the resolution of the value bins.
scale
string
Specifies the scale type. Possible values are `linear`.
default: `linear`
object
Y Axis controls for the distribution widget.
include_zero
boolean
True includes zero.
label
string
The label of the axis to display on the graph.
max
string
Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
min
string
Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear` or `log`.
default: `linear`
object
The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.
event_size
enum
Size to use to display an event. Allowed enum values: `s,l`
query [_required_]
string
Query to filter the event stream with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event stream widget. Allowed enum values: `event_stream`
default: `event_stream`
object
The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.
query [_required_]
string
Query to filter the event timeline with.
tags_execution
string
The execution method for multi-value filters. Can be either and or or.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the event timeline widget. Allowed enum values: `event_timeline`
default: `event_timeline`
object
Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
color
string
Color of the text.
font_size
string
Size of the text.
text [_required_]
string
Text to display.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the free text widget. Allowed enum values: `free_text`
default: `free_text`
object
The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
_required_]
[object]
Request payload used to query items.
_required_]
object
Updated funnel widget.
data_source [_required_]
enum
Source from which to query items to display in the funnel. Allowed enum values: `rum`
default: `rum`
query_string [_required_]
string
The widget query.
_required_]
[object]
List of funnel steps.
facet [_required_]
string
The facet of the step.
value [_required_]
string
The value of the step.
request_type [_required_]
enum
Widget request type. Allowed enum values: `funnel`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of funnel widget. Allowed enum values: `funnel`
default: `funnel`
object
This visualization displays a series of values by country on a world map.
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
<oneOf>
Replace rule for the table widget text format.
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
object
The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the group title.
banner_img
string
URL of image to display as a banner for the group.
layout_type [_required_]
enum
Layout type of the group. Allowed enum values: `ordered`
show_title
boolean
Whether to show the title or not.
default: `true`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
type [_required_]
enum
Type of the group widget. Allowed enum values: `group`
default: `group`
widgets [_required_]
[object]
List of widget groups.
object
The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
_required_]
[object]
List of widget types.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The event query.
search [_required_]
string
The query being made on the event.
tags_execution [_required_]
string
The execution method for multi-value filters. Can be either and or or.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
request_type
enum
Request type for the histogram request. Allowed enum values: `histogram`
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Widget style definition.
palette
string
Color palette to apply to the widget.
show_legend
boolean
Whether or not to display the legend on this widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the heat map widget. Allowed enum values: `heatmap`
default: `heatmap`
object
X Axis controls for the heat map widget.
num_buckets
int64
Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier).
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group
[string]
List of tag prefixes to group by.
no_group_hosts
boolean
Whether to show the hosts that don’t fit in a group.
no_metric_hosts
boolean
Whether to show the hosts with no metrics.
node_type
enum
Which type of node to use in the map. Allowed enum values: `host,container`
notes
string
Notes on the title.
_required_]
object
List of definitions.
object
Updated host map.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Updated host map.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
scope
[string]
List of tags used to filter the map.
object
The style to apply to the widget.
fill_max
string
Max value to use to color the map.
fill_min
string
Min value to use to color the map.
palette
string
Color palette to apply to the widget.
palette_flip
boolean
Whether to flip the palette tones.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the host map widget. Allowed enum values: `hostmap`
default: `hostmap`
object
The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
type [_required_]
enum
Type of the iframe widget. Allowed enum values: `iframe`
default: `iframe`
url [_required_]
string
URL of the iframe.
object
The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
has_background
boolean
Whether to display a background or not.
default: `true`
has_border
boolean
Whether to display a border or not.
default: `true`
horizontal_align
enum
Horizontal alignment. Allowed enum values: `center,left,right`
margin
enum
Size of the margins around the image. **Note** : `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large`
sizing
enum
How to size the image on the widget. The values are based on the image `object-fit` CSS properties. **Note** : `zoom`, `fit` and `center` values are deprecated. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center`
type [_required_]
enum
Type of the image widget. Allowed enum values: `image`
default: `image`
url [_required_]
string
URL of the image.
url_dark_theme
string
URL of the image in dark mode.
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
object
The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
_required_]
[object]
Request payload used to query items.
_required_]
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
_required_]
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format [_required_]
enum
Widget response format. Allowed enum values: `event_list`
show_legend
boolean
Whether or not to display the legend on this widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the list stream widget. Allowed enum values: `list_stream`
default: `list_stream`
object
The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
columns
[string]
Which columns to display on the widget.
indexes
[string]
An array of index names to query in the stream. Use [] to query all indexes at once.
logset
string
**DEPRECATED** : ID of the log set to use.
message_display
enum
Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg`
query
string
Query to filter the log stream with.
show_date_column
boolean
Whether to show the date column or not
show_message_column
boolean
Whether to show the message column or not
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the log stream widget. Allowed enum values: `log_stream`
default: `log_stream`
object
The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
color_preference
enum
Which color to use on the widget. Allowed enum values: `background,text`
count
int64
**DEPRECATED** : The number of monitors to display.
display_format
enum
What to display on the widget. Allowed enum values: `counts,countsAndList,list`
hide_zero_counts
boolean
Whether to show counts of 0 or not.
query [_required_]
string
Query to filter the monitors with.
show_last_triggered
boolean
Whether to show the time that has elapsed since the monitor/group triggered.
show_priority
boolean
Whether to show the priorities column.
sort
enum
Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc,status,desc,tags,asc,tags,desc,triggered,asc,triggered,desc,priority,asc,priority,desc`
start
int64
**DEPRECATED** : The start of the list. Typically 0.
summary_type
enum
Which summary type should be used. Allowed enum values: `monitors,groups,combined`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the monitor summary widget. Allowed enum values: `manage_status`
default: `manage_status`
object
The notes and links widget is similar to free text widget, but allows for more formatting options.
background_color
string
Background color of the note.
content [_required_]
string
Content of the note.
font_size
string
Size of the text.
has_padding
boolean
Whether to add padding or not.
default: `true`
show_tick
boolean
Whether to show a tick or not.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
tick_edge
enum
Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top`
tick_pos
string
Where to position the tick on an edge.
type [_required_]
enum
Type of the note widget. Allowed enum values: `note`
default: `note`
vertical_align
enum
Vertical alignment. Allowed enum values: `center,top,bottom`
object
The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the powerpack title.
banner_img
string
URL of image to display as a banner for the powerpack.
powerpack_id [_required_]
string
UUID of the associated powerpack.
show_title
boolean
Whether to show the title or not.
default: `true`
object
Powerpack template variables.
[object]
Template variables controlled at the powerpack level.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
[object]
Template variables controlled by the external resource, such as the dashboard this powerpack is on.
name [_required_]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable.
values [_required_]
[string]
One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.
title
string
Title of the widget.
type [_required_]
enum
Type of the powerpack widget. Allowed enum values: `powerpack`
default: `powerpack`
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
object
Run workflow is widget that allows you to run a workflow from a dashboard.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
[object]
Array of workflow inputs to map to dashboard template variables.
name [_required_]
string
Name of the workflow input.
value [_required_]
string
Dashboard template variable. Can be suffixed with '.value' or '.key'.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the run workflow widget. Allowed enum values: `run_workflow`
default: `run_workflow`
workflow_id [_required_]
string
Workflow id.
object
Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
_required_]
[object]
Array of one request object to display in the widget.
_required_]
object
Updated SLO List widget.
limit
int64
Maximum number of results to display in the table.
default: `100`
query_string [_required_]
string
Widget query.
[object]
Options for sorting results.
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
request_type [_required_]
enum
Widget request type. Allowed enum values: `slo_list`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO List widget. Allowed enum values: `slo_list`
default: `slo_list`
object
Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
additional_query_filters
string
Additional filters applied to the SLO query.
global_time_target
string
Defined global time target.
show_error_budget
boolean
Defined error budget.
slo_id
string
ID of the SLO displayed.
time_windows
[string]
Times being monitored.
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the SLO widget. Allowed enum values: `slo`
default: `slo`
view_mode
enum
Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both`
view_type [_required_]
string
Type of view displayed by the widget.
default: `detail`
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
object
Widget definition.
object
Scatterplot request containing formulas and functions.
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
This widget displays a map of a service to all of the services that call it, and all of the services that it calls.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
filters [_required_]
[string]
Your environment and primary tag (or * if enabled for your account).
service [_required_]
string
The ID of the service you want to map.
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service map widget. Allowed enum values: `servicemap`
default: `servicemap`
object
The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
display_format
enum
Number of columns to display. Allowed enum values: `one_column,two_column,three_column`
env [_required_]
string
APM environment.
service [_required_]
string
APM service.
show_breakdown
boolean
Whether to show the latency breakdown or not.
show_distribution
boolean
Whether to show the latency distribution or not.
show_errors
boolean
Whether to show the error metrics or not.
show_hits
boolean
Whether to show the hits metrics or not.
show_latency
boolean
Whether to show the latency metrics or not.
show_resource_list
boolean
Whether to show the resource list or not.
size_format
enum
Size of the widget. Allowed enum values: `small,medium,large`
span_name [_required_]
string
APM span name.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the service summary widget. Allowed enum values: `trace_service`
default: `trace_service`
object
The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service)
has_uniform_y_axes
boolean
Normalize y axes across graphs
size [_required_]
enum
Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg`
_required_]
<oneOf>
The original widget we are splitting on.
object
The Change graph shows you the change in a value over the time period chosen.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
Array of one request object to display in the widget.
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
change_type
enum
Show the absolute or the relative change. Allowed enum values: `absolute,relative`
compare_to
enum
Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
increase_good
boolean
Whether to show increase as good.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order_by
enum
What to order by. Allowed enum values: `change,name,present,past`
order_dir
enum
Widget sorting methods. Allowed enum values: `asc,desc`
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
show_present
boolean
Whether to show the present value.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of the widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the change widget. Allowed enum values: `change`
default: `change`
object
This visualization displays a series of values by country on a world map.
[object]
A list of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.
[object]
Widget columns.
field [_required_]
string
Widget column field.
width [_required_]
enum
Widget column width. Allowed enum values: `auto,compact,full`
[object]
Threshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
The widget metrics query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
object
Updated list stream widget.
clustering_pattern_field_path
string
Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
[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_]
enum
Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,earliest,latest,most_frequent`
facet
string
Facet name.
data_source [_required_]
enum
Source from which to query items to display in the stream. Allowed 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
enum
Size to use to display an event. Allowed enum values: `s,l`
[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_]
string
Facet name.
indexes
[string]
List of indexes.
query_string [_required_]
string
Widget query.
object
Which column and order to sort by
column [_required_]
string
Facet path for the column
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
storage
string
Option for storage location. Feature in Private Beta.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
object
The style to apply to the request for points layer.
color_by
string
The category to color the points by.
[object]
Text formatting rules may be used by a points layer.
custom_bg_color
string
Hex representation of the custom background color. Used with custom background palette option.
custom_fg_color
string
Hex representation of the custom text color. Used with custom text palette option.
_required_]
object
Match rule for the table widget text format.
type [_required_]
enum
Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with`
value [_required_]
string
Table Widget Match String.
palette
enum
Color-on-color palette to highlight replaced text. Allowed enum values: `white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg,custom_text`
default: `white_on_green`
<oneOf>
Replace rule for the table widget text format.
object
Match All definition.
type [_required_]
enum
Table widget text format replace all type. Allowed enum values: `all`
with [_required_]
string
Replace All type.
object
Match Sub-string definition.
substring [_required_]
string
Text that will be replaced.
type [_required_]
enum
Table widget text format replace sub-string type. Allowed enum values: `substring`
with [_required_]
string
Text that will replace original sub-string.
_required_]
object
The style to apply to the widget.
palette [_required_]
string
The color palette to apply to the widget.
palette_flip [_required_]
boolean
Whether to flip the palette tones.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
The title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
The size of the title.
type [_required_]
enum
Type of the geomap widget. Allowed enum values: `geomap`
default: `geomap`
_required_]
object
The view of the world that the map should render.
focus [_required_]
string
The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
object
Query values display the current value of a given metric, APM, or log query.
autoscale
boolean
Whether to use auto-scaling or not.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
TODO.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
text_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
object
Set a timeseries on the widget background.
type [_required_]
enum
Timeseries is made using an area or bars. Allowed enum values: `bars,area`
default: `area`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the query value widget. Allowed enum values: `query_value`
default: `query_value`
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
object
Widget definition.
object
Scatterplot request containing formulas and functions.
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [_required_]
enum
Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color`
formula [_required_]
string
String expression built from queries, formulas, and functions.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the scatter plot widget. Allowed enum values: `scatterplot`
default: `scatterplot`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
<oneOf>
Configuration of the legend.
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
_required_]
[object]
List of sunburst widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Widget style definition.
palette
string
Color palette to apply to the widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The APM stats query for table and distributions widgets.
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
_required_]
[object]
List of timeseries widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
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.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
List of top list widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Style customization for a top list widget.
<oneOf>
Top list widget display options.
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
_required_]
[object]
List of treemap widget requests.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
_required_]
object
Encapsulates all user choices about how to split a graph.
limit [_required_]
int64
Maximum number of graphs to display in the widget.
_required_]
object
Controls the order in which graphs appear in the split.
object
Defines the metric and aggregation used as the sort value.
aggregation [_required_]
string
How to aggregate the sort metric for the purposes of ordering.
metric [_required_]
string
The metric to use for sorting graphs.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
_required_]
[object]
The dimension(s) on which to split the graph
one_graph_per [_required_]
string
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
[array]
Manual selection of tags making split graph widget static
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the split graph widget Allowed enum values: `split_group`
default: `split_group`
object
Sunbursts are spot on to highlight how groups contribute to the total of a query.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
hide_total
boolean
Show the total value in this widget.
<oneOf>
Configuration of the legend.
object
Configuration of table-based legend.
type [_required_]
enum
Whether or not to show a table legend. Allowed enum values: `table,none`
object
Configuration of inline or automatic legends.
hide_percent
boolean
Whether to hide the percentages of the groups.
hide_value
boolean
Whether to hide the values of the groups.
type [_required_]
enum
Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic`
_required_]
[object]
List of sunburst widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Widget style definition.
palette
string
Color palette to apply to the widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the Sunburst widget. Allowed enum values: `sunburst`
default: `sunburst`
object
The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
has_search_bar
enum
Controls the display of the search bar. Allowed enum values: `always,never,auto`
_required_]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
alias
string
The column name (defaults to the metric name).
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The APM stats query for table and distributions widgets.
[object]
Column properties used by the front end for display.
alias
string
A user-assigned alias for the column.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
name [_required_]
string
Column name.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
env [_required_]
string
Environment name.
name [_required_]
string
Operation name associated with service.
primary_tag [_required_]
string
The organization's host group name and value.
resource
string
Resource name.
row_type [_required_]
enum
The level of detail for the request. Allowed enum values: `service,resource,span`
service [_required_]
string
Service name.
cell_display_mode
[string]
A list of display modes for each table cell.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
limit
int64
For metric queries, the number of lines to show in the table. Only one request should have this property.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
order
enum
Widget sorting methods. Allowed enum values: `asc,desc`
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Query definition.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
text_formats
[array]
List of text formats for columns produced by tags.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the table widget. Allowed enum values: `query_table`
default: `query_table`
object
The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
[object]
List of widget events.
q [_required_]
string
Query definition.
tags_execution
string
The execution method for multi-value filters.
legend_columns
[string]
Columns displayed in the legend.
legend_layout
enum
Layout of the legend. Allowed enum values: `auto,horizontal,vertical`
legend_size
string
Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
[object]
List of markers.
display_type
string
Combination of:
  * A severity error, warning, ok, or info
  * A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`.


label
string
Label to display over the marker.
time
string
Timestamp for the widget.
value [_required_]
string
Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90).
_required_]
[object]
List of timeseries widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
display_type
enum
Type of display to use for the request. Allowed enum values: `area,bars,line,overlay`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
Used to define expression aliases.
alias_name
string
Expression alias.
expression [_required_]
string
Expression name.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
on_right_yaxis
boolean
Whether or not to display a second y-axis on the right.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
show_legend
boolean
(screenboard only) Show the legend for this widget.
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the timeseries widget. Allowed enum values: `timeseries`
default: `timeseries`
object
Axis controls for the widget.
include_zero
boolean
Set to `true` to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
min
string
Specifies minimum numeric value to show on the axis. Defaults to `auto`.
default: `auto`
scale
string
Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
default: `linear`
object
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.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
List of top list widget requests.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [_required_]
string
Your chosen metric.
search_by
string
Your chosen search term.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
q
string
Widget query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The log query.
object
Define computation for a log query.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [_required_]
string
Facet name.
limit
int64
Maximum number of items in the group.
object
Define a sorting method.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
index
string
A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
[object]
This field is mutually exclusive with `compute`.
aggregation [_required_]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
object
The query being made on the logs.
query [_required_]
string
Search value to apply.
object
The controls for sorting the widget.
count
int64
The number of items to limit the widget to.
[ <oneOf>]
The array of items to sort the widget by in order.
object
The formula to sort the widget by.
index [_required_]
int64
The index of the formula to sort by.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to formula. Allowed enum values: `formula`
object
The group to sort the widget by.
name [_required_]
string
The name of the group.
order [_required_]
enum
Widget sorting methods. Allowed enum values: `asc,desc`
type [_required_]
enum
Set the sort type to group. Allowed enum values: `group`
object
Define request widget style.
line_type
enum
Type of lines displayed. Allowed enum values: `dashed,dotted,solid`
line_width
enum
Width of line displayed. Allowed enum values: `normal,thick,thin`
palette
string
Color palette to apply to the widget.
object
Style customization for a top list widget.
<oneOf>
Top list widget display options.
object
Top list widget stacked display options.
legend
enum
Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none`
type [_required_]
enum
Top list widget stacked display type. Allowed enum values: `stacked`
default: `stacked`
object
Top list widget flat display.
type [_required_]
enum
Top list widget flat display type. Allowed enum values: `flat`
default: `flat`
palette
string
Color palette to apply to the widget.
scaling
enum
Top list widget scaling definition. Allowed enum values: `absolute,relative`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the top list widget. Allowed enum values: `toplist`
default: `toplist`
object
This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
_required_]
[object]
One or more Topology requests.
object
Query to service-based topology data sources like the service map or data streams.
data_source
enum
Name of the data source Allowed enum values: `data_streams,service_map`
filters
[string]
Your environment and primary tag (or * if enabled for your account).
service
string
Name of the service
request_type
enum
Widget request type. Allowed enum values: `topology`
title
string
Title of your widget.
title_align
enum
How to align the text on the widget. Allowed enum values: `center,left,right`
title_size
string
Size of the title.
type [_required_]
enum
Type of the topology map widget. Allowed enum values: `topology_map`
default: `topology_map`
object
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
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`
default: `user`
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.
override_label
string
The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
group_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process`
_required_]
[object]
List of treemap widget requests.
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell. Allowed enum values: `number,bar,trend`
object
Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
trend_type
enum
Trend type for the cell display mode options. Allowed enum values: `area,line,bars`
y_scale
enum
Y scale for the cell display mode options. Allowed enum values: `shared,independent`
[object]
List of conditional formats.
comparator [_required_]
enum
Comparator to apply. Allowed enum values: `=,>,>=,<,<=`
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [_required_]
enum
Color palette to apply. Allowed 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
string
Defines the displayed timeframe.
value [_required_]
double
Value for the comparator.
formula [_required_]
string
String expression built from queries, formulas, and functions.
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
object
Number format options for the widget.
<oneOf>
Number format unit.
object
Canonical unit.
per_unit_name
string
The name of the unit per item.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Custom unit.
label
string
The label for the custom unit.
type
enum
The type of custom unit. Allowed enum values: `custom_unit_label`
object
The definition of `NumberFormatUnitScale` object.
type
enum
The type of unit scale. Allowed enum values: `canonical_unit`
unit_name
string
The name of the unit.
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at <https://docs.datadoghq.com/dashboards/guide/widget_colors>
palette_index
int64
Index specifying which color to use within the palette.
q
string
The widget metrics query.
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for metrics queries. Allowed enum values: `metrics`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Metrics query definition.
semantic_mode
enum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native`
object
A formula and functions events query.
_required_]
object
Compute options.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines,incident_analytics,product_analytics,on_call_events`
[object]
Group by options.
facet [_required_]
string
Event facet.
limit
int64
Number of groups to return.
object
Options for sorting group by results.
aggregation [_required_]
enum
Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg`
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
indexes
[string]
An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
name [_required_]
string
Name of the query for use in formulas.
object
Search options.
query [_required_]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data sources that rely on the process backend. Allowed enum values: `process,container`
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [_required_]
string
Process metric name.
name [_required_]
string
Name of query for use in formulas.
sort
enum
Direction of sort. Allowed enum values: `asc,desc`
default: `desc`
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
object
A formula and functions APM dependency stats query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`
env [_required_]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [_required_]
string
Name of query to use in formulas.
operation_name [_required_]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>.
primary_tag_value
string
Filter APM data by the second primary tag. `primary_tag_name` must also be specified.
resource_name [_required_]
string
APM resource.
service [_required_]
string
APM service.
stat [_required_]
enum
APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count`
object
APM resource stats query using formulas and functions.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`
env [_required_]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [_required_]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See <https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog>
primary_tag_value
string
Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.
resource_name
string
APM resource name.
service [_required_]
string
APM service name.
stat [_required_]
enum
APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for SLO measures queries. Allowed enum values: `slo`
group_mode
enum
Group mode to query measures. Allowed enum values: `overall,components`
measure [_required_]
enum
SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`
name
string
Name of the query for use in formulas.
slo_id [_required_]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice`
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [_required_]
enum
Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`
name [_required_]
string
Name of the query for use in formulas.
query [_required_]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list`
size_by
enum
**DEPRECATED** : (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem`
<oneOf>
Time setting for the widget.
object
Wrapper for live span
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
live_span
enum
The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert`
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
type [_required_]
enum
Type "live" denotes a live span in the new format. Allowed enum values: `live`
unit [_required_]
enum
Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year`
value [_required_]
int64
Value of the time span.
object
Used for fixed span times, such as 'March 1 to March 7'.
from [_required_]
int64
Start time in seconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [_required_]
int64
End time in seconds since epoch.
type [_required_]
enum
Type "fixed" denotes a fixed span. Allowed enum values: `fixed`
title
string
Title of your widget.
type [_required_]
enum
Type of the treemap widget. Allowed enum values: `treemap`
default: `treemap`
id
int64
ID of the widget.
object
The layout for a widget on a `free` or **new dashboard layout** dashboard.
height [_required_]
int64
The height of the widget. Should be a non-negative integer.
is_column_break
boolean
Whether the widget should be the first one on the second column in high density or not. **Note** : Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`.
width [_required_]
int64
The width of the widget. Should be a non-negative integer.
x [_required_]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [_required_]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
```
{
  "author_handle": "test@datadoghq.com",
  "author_name": "John Doe",
  "created_at": "2019-09-19T10:00:00.000Z",
  "description": "string",
  "id": "123-abc-456",
  "is_read_only": false,
  "layout_type": "ordered",
  "modified_at": "2019-09-19T10:00:00.000Z",
  "notify_list": [],
  "reflow_type": "string",
  "restricted_roles": [],
  "tags": [],
  "template_variable_presets": [
    {
      "name": "string",
      "template_variables": [
        {
          "name": "string",
          "value": "string",
          "values": []
        }
      ]
    }
  ],
  "template_variables": [
    {
      "available_values": [
        "my-host",
        "host1",
        "host2"
      ],
      "default": "my-host",
      "defaults": [
        "my-host-1",
        "my-host-2"
      ],
      "name": "host1",
      "prefix": "host",
      "type": "group"
    }
  ],
  "title": "",
  "url": "/dashboard/123-abc-456/example-dashboard-title",
  "widgets": [
    {
      "definition": {
        "requests": {
          "fill": {
            "q": "avg:system.cpu.user{*}"
          }
        },
        "type": "hostmap"
      },
      "id": "integer",
      "layout": {
        "height": 0,
        "is_column_break": false,
        "width": 0,
        "x": 0,
        "y": 0
      }
    }
  ]
}
```

Copy
Bad Request
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Authentication Error
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Item Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Update a dashboard returns "OK" response
Copy
```
                          # Path parameters  
export dashboard_id="CHANGE_ME"  
# Curl command  
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "layout_type": "ordered",
  "title": "Example-Dashboard with list_stream widget",
  "description": "Updated description",
  "widgets": [
    {
      "definition": {
        "type": "list_stream",
        "requests": [
          {
            "columns": [
              {
                "width": "auto",
                "field": "timestamp"
              }
            ],
            "query": {
              "data_source": "apm_issue_stream",
              "query_string": ""
            },
            "response_format": "event_list"
          }
        ]
      }
    }
  ]
}
EOF  

                        
```

#####  Update a dashboard with tags returns "OK" response
Copy
```
                          # Path parameters  
export dashboard_id="CHANGE_ME"  
# Curl command  
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "layout_type": "ordered",
  "title": "Example-Dashboard with list_stream widget",
  "description": "Updated description",
  "tags": [
    "team:foo",
    "team:bar"
  ],
  "widgets": [
    {
      "definition": {
        "type": "list_stream",
        "requests": [
          {
            "columns": [
              {
                "width": "auto",
                "field": "timestamp"
              }
            ],
            "query": {
              "data_source": "apm_issue_stream",
              "query_string": ""
            },
            "response_format": "event_list"
          }
        ]
      }
    }
  ]
}
EOF  

                        
```

#####  Update a dashboard returns "OK" response 
```
// Update a dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	body := datadogV1.Dashboard{
		LayoutType:  datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,
		Title:       "Example-Dashboard with list_stream widget",
		Description: *datadog.NewNullableString(datadog.PtrString("Updated description")),
		Widgets: []datadogV1.Widget{
			{
				Definition: datadogV1.WidgetDefinition{
					ListStreamWidgetDefinition: &datadogV1.ListStreamWidgetDefinition{
						Type: datadogV1.LISTSTREAMWIDGETDEFINITIONTYPE_LIST_STREAM,
						Requests: []datadogV1.ListStreamWidgetRequest{
							{
								Columns: []datadogV1.ListStreamColumn{
									{
										Width: datadogV1.LISTSTREAMCOLUMNWIDTH_AUTO,
										Field: "timestamp",
									},
								},
								Query: datadogV1.ListStreamQuery{
									DataSource:  datadogV1.LISTSTREAMSOURCE_APM_ISSUE_STREAM,
									QueryString: "",
								},
								ResponseFormat: datadogV1.LISTSTREAMRESPONSEFORMAT_EVENT_LIST,
							},
						},
					}},
			},
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.UpdateDashboard(ctx, DashboardID, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdateDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdateDashboard`:\n%s\n", responseContent)
}

```

Copy
#####  Update a dashboard with tags returns "OK" response 
```
// Update a dashboard with tags returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	body := datadogV1.Dashboard{
		LayoutType:  datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,
		Title:       "Example-Dashboard with list_stream widget",
		Description: *datadog.NewNullableString(datadog.PtrString("Updated description")),
		Tags: *datadog.NewNullableList(&[]string{
			"team:foo",
			"team:bar",
		}),
		Widgets: []datadogV1.Widget{
			{
				Definition: datadogV1.WidgetDefinition{
					ListStreamWidgetDefinition: &datadogV1.ListStreamWidgetDefinition{
						Type: datadogV1.LISTSTREAMWIDGETDEFINITIONTYPE_LIST_STREAM,
						Requests: []datadogV1.ListStreamWidgetRequest{
							{
								Columns: []datadogV1.ListStreamColumn{
									{
										Width: datadogV1.LISTSTREAMCOLUMNWIDTH_AUTO,
										Field: "timestamp",
									},
								},
								Query: datadogV1.ListStreamQuery{
									DataSource:  datadogV1.LISTSTREAMSOURCE_APM_ISSUE_STREAM,
									QueryString: "",
								},
								ResponseFormat: datadogV1.LISTSTREAMRESPONSEFORMAT_EVENT_LIST,
							},
						},
					}},
			},
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.UpdateDashboard(ctx, DashboardID, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdateDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdateDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Update a dashboard returns "OK" response 
```
// Update a dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.ListStreamColumn;
import com.datadog.api.client.v1.model.ListStreamColumnWidth;
import com.datadog.api.client.v1.model.ListStreamQuery;
import com.datadog.api.client.v1.model.ListStreamResponseFormat;
import com.datadog.api.client.v1.model.ListStreamSource;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinition;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinitionType;
import com.datadog.api.client.v1.model.ListStreamWidgetRequest;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    Dashboard body =
        new Dashboard()
            .layoutType(DashboardLayoutType.ORDERED)
            .title("Example-Dashboard with list_stream widget")
            .description("Updated description")
            .widgets(
                Collections.singletonList(
                    new Widget()
                        .definition(
                            new WidgetDefinition(
                                new ListStreamWidgetDefinition()
                                    .type(ListStreamWidgetDefinitionType.LIST_STREAM)
                                    .requests(
                                        Collections.singletonList(
                                            new ListStreamWidgetRequest()
                                                .columns(
                                                    Collections.singletonList(
                                                        new ListStreamColumn()
                                                            .width(ListStreamColumnWidth.AUTO)
                                                            .field("timestamp")))
                                                .query(
                                                    new ListStreamQuery()
                                                        .dataSource(
                                                            ListStreamSource.APM_ISSUE_STREAM)
                                                        .queryString(""))
                                                .responseFormat(
                                                    ListStreamResponseFormat.EVENT_LIST)))))));

    try {
      Dashboard result = apiInstance.updateDashboard(DASHBOARD_ID, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#updateDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#####  Update a dashboard with tags returns "OK" response 
```
// Update a dashboard with tags returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.ListStreamColumn;
import com.datadog.api.client.v1.model.ListStreamColumnWidth;
import com.datadog.api.client.v1.model.ListStreamQuery;
import com.datadog.api.client.v1.model.ListStreamResponseFormat;
import com.datadog.api.client.v1.model.ListStreamSource;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinition;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinitionType;
import com.datadog.api.client.v1.model.ListStreamWidgetRequest;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import java.util.Arrays;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    Dashboard body =
        new Dashboard()
            .layoutType(DashboardLayoutType.ORDERED)
            .title("Example-Dashboard with list_stream widget")
            .description("Updated description")
            .tags(Arrays.asList("team:foo", "team:bar"))
            .widgets(
                Collections.singletonList(
                    new Widget()
                        .definition(
                            new WidgetDefinition(
                                new ListStreamWidgetDefinition()
                                    .type(ListStreamWidgetDefinitionType.LIST_STREAM)
                                    .requests(
                                        Collections.singletonList(
                                            new ListStreamWidgetRequest()
                                                .columns(
                                                    Collections.singletonList(
                                                        new ListStreamColumn()
                                                            .width(ListStreamColumnWidth.AUTO)
                                                            .field("timestamp")))
                                                .query(
                                                    new ListStreamQuery()
                                                        .dataSource(
                                                            ListStreamSource.APM_ISSUE_STREAM)
                                                        .queryString(""))
                                                .responseFormat(
                                                    ListStreamResponseFormat.EVENT_LIST)))))));

    try {
      Dashboard result = apiInstance.updateDashboard(DASHBOARD_ID, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#updateDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Update a dashboard returns "OK" response 
```
"""
Update a dashboard returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
from datadog_api_client.v1.model.list_stream_response_format import ListStreamResponseFormat
from datadog_api_client.v1.model.list_stream_source import ListStreamSource
from datadog_api_client.v1.model.list_stream_widget_definition import ListStreamWidgetDefinition
from datadog_api_client.v1.model.list_stream_widget_definition_type import ListStreamWidgetDefinitionType
from datadog_api_client.v1.model.list_stream_widget_request import ListStreamWidgetRequest
from datadog_api_client.v1.model.widget import Widget

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

body = Dashboard(
    layout_type=DashboardLayoutType.ORDERED,
    title="Example-Dashboard with list_stream widget",
    description="Updated description",
    widgets=[
        Widget(
            definition=ListStreamWidgetDefinition(
                type=ListStreamWidgetDefinitionType.LIST_STREAM,
                requests=[
                    ListStreamWidgetRequest(
                        columns=[
                            ListStreamColumn(
                                width=ListStreamColumnWidth.AUTO,
                                field="timestamp",
                            ),
                        ],
                        query=ListStreamQuery(
                            data_source=ListStreamSource.APM_ISSUE_STREAM,
                            query_string="",
                        ),
                        response_format=ListStreamResponseFormat.EVENT_LIST,
                    ),
                ],
            ),
        ),
    ],
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.update_dashboard(dashboard_id=DASHBOARD_ID, body=body)

    print(response)

```

Copy
#####  Update a dashboard with tags returns "OK" response 
```
"""
Update a dashboard with tags returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
from datadog_api_client.v1.model.list_stream_response_format import ListStreamResponseFormat
from datadog_api_client.v1.model.list_stream_source import ListStreamSource
from datadog_api_client.v1.model.list_stream_widget_definition import ListStreamWidgetDefinition
from datadog_api_client.v1.model.list_stream_widget_definition_type import ListStreamWidgetDefinitionType
from datadog_api_client.v1.model.list_stream_widget_request import ListStreamWidgetRequest
from datadog_api_client.v1.model.widget import Widget

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

body = Dashboard(
    layout_type=DashboardLayoutType.ORDERED,
    title="Example-Dashboard with list_stream widget",
    description="Updated description",
    tags=[
        "team:foo",
        "team:bar",
    ],
    widgets=[
        Widget(
            definition=ListStreamWidgetDefinition(
                type=ListStreamWidgetDefinitionType.LIST_STREAM,
                requests=[
                    ListStreamWidgetRequest(
                        columns=[
                            ListStreamColumn(
                                width=ListStreamColumnWidth.AUTO,
                                field="timestamp",
                            ),
                        ],
                        query=ListStreamQuery(
                            data_source=ListStreamSource.APM_ISSUE_STREAM,
                            query_string="",
                        ),
                        response_format=ListStreamResponseFormat.EVENT_LIST,
                    ),
                ],
            ),
        ),
    ],
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.update_dashboard(dashboard_id=DASHBOARD_ID, body=body)

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Update a dashboard returns "OK" response 
```
# Update a dashboard returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]

body = DatadogAPIClient::V1::Dashboard.new({
  layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
  title: "Example-Dashboard with list_stream widget",
  description: "Updated description",
  widgets: [
    DatadogAPIClient::V1::Widget.new({
      definition: DatadogAPIClient::V1::ListStreamWidgetDefinition.new({
        type: DatadogAPIClient::V1::ListStreamWidgetDefinitionType::LIST_STREAM,
        requests: [
          DatadogAPIClient::V1::ListStreamWidgetRequest.new({
            columns: [
              DatadogAPIClient::V1::ListStreamColumn.new({
                width: DatadogAPIClient::V1::ListStreamColumnWidth::AUTO,
                field: "timestamp",
              }),
            ],
            query: DatadogAPIClient::V1::ListStreamQuery.new({
              data_source: DatadogAPIClient::V1::ListStreamSource::APM_ISSUE_STREAM,
              query_string: "",
            }),
            response_format: DatadogAPIClient::V1::ListStreamResponseFormat::EVENT_LIST,
          }),
        ],
      }),
    }),
  ],
})
p api_instance.update_dashboard(DASHBOARD_ID, body)

```

Copy
#####  Update a dashboard with tags returns "OK" response 
```
# Update a dashboard with tags returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]

body = DatadogAPIClient::V1::Dashboard.new({
  layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
  title: "Example-Dashboard with list_stream widget",
  description: "Updated description",
  tags: [
    "team:foo",
    "team:bar",
  ],
  widgets: [
    DatadogAPIClient::V1::Widget.new({
      definition: DatadogAPIClient::V1::ListStreamWidgetDefinition.new({
        type: DatadogAPIClient::V1::ListStreamWidgetDefinitionType::LIST_STREAM,
        requests: [
          DatadogAPIClient::V1::ListStreamWidgetRequest.new({
            columns: [
              DatadogAPIClient::V1::ListStreamColumn.new({
                width: DatadogAPIClient::V1::ListStreamColumnWidth::AUTO,
                field: "timestamp",
              }),
            ],
            query: DatadogAPIClient::V1::ListStreamQuery.new({
              data_source: DatadogAPIClient::V1::ListStreamSource::APM_ISSUE_STREAM,
              query_string: "",
            }),
            response_format: DatadogAPIClient::V1::ListStreamResponseFormat::EVENT_LIST,
          }),
        ],
      }),
    }),
  ],
})
p api_instance.update_dashboard(DASHBOARD_ID, body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Update a dashboard returns "OK" response 
```
// Update a dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::Dashboard;
use datadog_api_client::datadogV1::model::DashboardLayoutType;
use datadog_api_client::datadogV1::model::ListStreamColumn;
use datadog_api_client::datadogV1::model::ListStreamColumnWidth;
use datadog_api_client::datadogV1::model::ListStreamQuery;
use datadog_api_client::datadogV1::model::ListStreamResponseFormat;
use datadog_api_client::datadogV1::model::ListStreamSource;
use datadog_api_client::datadogV1::model::ListStreamWidgetDefinition;
use datadog_api_client::datadogV1::model::ListStreamWidgetDefinitionType;
use datadog_api_client::datadogV1::model::ListStreamWidgetRequest;
use datadog_api_client::datadogV1::model::Widget;
use datadog_api_client::datadogV1::model::WidgetDefinition;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = Dashboard::new(
        DashboardLayoutType::ORDERED,
        "Example-Dashboard with list_stream widget".to_string(),
        vec![Widget::new(WidgetDefinition::ListStreamWidgetDefinition(
            Box::new(ListStreamWidgetDefinition::new(
                vec![ListStreamWidgetRequest::new(
                    vec![ListStreamColumn::new(
                        "timestamp".to_string(),
                        ListStreamColumnWidth::AUTO,
                    )],
                    ListStreamQuery::new(ListStreamSource::APM_ISSUE_STREAM, "".to_string()),
                    ListStreamResponseFormat::EVENT_LIST,
                )],
                ListStreamWidgetDefinitionType::LIST_STREAM,
            )),
        ))],
    )
    .description(Some("Updated description".to_string()));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.update_dashboard(dashboard_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#####  Update a dashboard with tags returns "OK" response 
```
// Update a dashboard with tags returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::Dashboard;
use datadog_api_client::datadogV1::model::DashboardLayoutType;
use datadog_api_client::datadogV1::model::ListStreamColumn;
use datadog_api_client::datadogV1::model::ListStreamColumnWidth;
use datadog_api_client::datadogV1::model::ListStreamQuery;
use datadog_api_client::datadogV1::model::ListStreamResponseFormat;
use datadog_api_client::datadogV1::model::ListStreamSource;
use datadog_api_client::datadogV1::model::ListStreamWidgetDefinition;
use datadog_api_client::datadogV1::model::ListStreamWidgetDefinitionType;
use datadog_api_client::datadogV1::model::ListStreamWidgetRequest;
use datadog_api_client::datadogV1::model::Widget;
use datadog_api_client::datadogV1::model::WidgetDefinition;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = Dashboard::new(
        DashboardLayoutType::ORDERED,
        "Example-Dashboard with list_stream widget".to_string(),
        vec![Widget::new(WidgetDefinition::ListStreamWidgetDefinition(
            Box::new(ListStreamWidgetDefinition::new(
                vec![ListStreamWidgetRequest::new(
                    vec![ListStreamColumn::new(
                        "timestamp".to_string(),
                        ListStreamColumnWidth::AUTO,
                    )],
                    ListStreamQuery::new(ListStreamSource::APM_ISSUE_STREAM, "".to_string()),
                    ListStreamResponseFormat::EVENT_LIST,
                )],
                ListStreamWidgetDefinitionType::LIST_STREAM,
            )),
        ))],
    )
    .description(Some("Updated description".to_string()))
    .tags(Some(vec!["team:foo".to_string(), "team:bar".to_string()]));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.update_dashboard(dashboard_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Update a dashboard returns "OK" response 
```
/**
 * Update a dashboard returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiUpdateDashboardRequest = {
  body: {
    layoutType: "ordered",
    title: "Example-Dashboard with list_stream widget",
    description: "Updated description",
    widgets: [
      {
        definition: {
          type: "list_stream",
          requests: [
            {
              columns: [
                {
                  width: "auto",
                  field: "timestamp",
                },
              ],
              query: {
                dataSource: "apm_issue_stream",
                queryString: "",
              },
              responseFormat: "event_list",
            },
          ],
        },
      },
    ],
  },
  dashboardId: DASHBOARD_ID,
};

apiInstance
  .updateDashboard(params)
  .then((data: v1.Dashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#####  Update a dashboard with tags returns "OK" response 
```
/**
 * Update a dashboard with tags returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiUpdateDashboardRequest = {
  body: {
    layoutType: "ordered",
    title: "Example-Dashboard with list_stream widget",
    description: "Updated description",
    tags: ["team:foo", "team:bar"],
    widgets: [
      {
        definition: {
          type: "list_stream",
          requests: [
            {
              columns: [
                {
                  width: "auto",
                  field: "timestamp",
                },
              ],
              query: {
                dataSource: "apm_issue_stream",
                queryString: "",
              },
              responseFormat: "event_list",
            },
          ],
        },
      },
    ],
  },
  dashboardId: DASHBOARD_ID,
};

apiInstance
  .updateDashboard(params)
  .then((data: v1.Dashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Delete a dashboard](https://docs.datadoghq.com/api/latest/dashboards/#delete-a-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#delete-a-dashboard-v1)


DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id}
### Overview
Delete a dashboard using the specified ID. This endpoint requires the `dashboards_write` permission.
OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
dashboard_id [_required_]
string
The ID of the dashboard.
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboard-200-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboard-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboard-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Response from the delete dashboard call.
Expand All
Field
Type
Description
deleted_dashboard_id
string
ID of the deleted dashboard.
```
{
  "deleted_dashboard_id": "string"
}
```

Copy
Authentication Error
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Dashboards Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)
  * [Ruby [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby-legacy)
  * [Python [legacy]](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python-legacy)


#####  Delete a dashboard
Copy
```
                  # Path parameters  
export dashboard_id="CHANGE_ME"  
# Curl command  
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"  

                
```

#####  Delete a dashboard
```
"""
Delete a dashboard returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.delete_dashboard(
        dashboard_id=DASHBOARD_ID,
    )

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Delete a dashboard
```
# Delete a dashboard returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
p api_instance.delete_dashboard(DASHBOARD_ID)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Delete a dashboard
```
require 'rubygems'
require 'dogapi'

api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'

dog = Dogapi::Client.new(api_key, app_key)

dashboard_id = '<DASHBOARD_ID>'
dog.delete_board(dashboard_id)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Delete a dashboard
```
// Delete a dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.DeleteDashboard(ctx, DashboardID)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeleteDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.DeleteDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Delete a dashboard
```
// Delete a dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardDeleteResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    try {
      DashboardDeleteResponse result = apiInstance.deleteDashboard(DASHBOARD_ID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#deleteDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Delete a dashboard
```
from datadog import initialize, api

options = {
    'api_key': '<DATADOG_API_KEY>',
    'app_key': '<DATADOG_APPLICATION_KEY>'
}

initialize(**options)

dashboard_id = '<DASHBOARD_ID>'

api.Dashboard.delete(dashboard_id)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"


```

#####  Delete a dashboard
```
// Delete a dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.delete_dashboard(dashboard_id.clone()).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Delete a dashboard
```
/**
 * Delete a dashboard returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiDeleteDashboardRequest = {
  dashboardId: DASHBOARD_ID,
};

apiInstance
  .deleteDashboard(params)
  .then((data: v1.DashboardDeleteResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Delete dashboards](https://docs.datadoghq.com/api/latest/dashboards/#delete-dashboards)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#delete-dashboards-v1)


DELETE https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.ap2.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
### Overview
Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed). This endpoint requires the `dashboards_write` permission.
OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Request
#### Body Data (required)
Delete dashboards request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Expand All
Field
Type
Description
_required_]
[object]
List of dashboard bulk action request data objects.
id [_required_]
string
Dashboard resource ID.
type [_required_]
enum
Dashboard resource type. Allowed enum values: `dashboard`
default: `dashboard`
```
{
  "data": [
    {
      "id": "123-abc-456",
      "type": "dashboard"
    }
  ]
}
```

Copy
### Response
  * [204](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboards-204-v1)
  * [400](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboards-400-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboards-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboards-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#DeleteDashboards-429-v1)


No Content
Bad Request
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Dashboards Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Delete dashboards returns "No Content" response
Copy
```
                          ## json-request-body
# 
  
# Curl command  
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": [
    {
      "id": "123-abc-456",
      "type": "dashboard"
    },
    {
      "id": "789-def-101",
      "type": "dashboard"
    }
  ]
}
EOF  

                        
```

#####  Delete dashboards returns "No Content" response
```
// Delete dashboards returns "No Content" response

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	body := datadogV1.DashboardBulkDeleteRequest{
		Data: []datadogV1.DashboardBulkActionData{
			{
				Id:   DashboardID,
				Type: datadogV1.DASHBOARDRESOURCETYPE_DASHBOARD,
			},
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	r, err := api.DeleteDashboards(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeleteDashboards`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Delete dashboards returns "No Content" response
```
// Delete dashboards returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardBulkActionData;
import com.datadog.api.client.v1.model.DashboardBulkDeleteRequest;
import com.datadog.api.client.v1.model.DashboardResourceType;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    DashboardBulkDeleteRequest body =
        new DashboardBulkDeleteRequest()
            .data(
                Collections.singletonList(
                    new DashboardBulkActionData()
                        .id(DASHBOARD_ID)
                        .type(DashboardResourceType.DASHBOARD)));

    try {
      apiInstance.deleteDashboards(body);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#deleteDashboards");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Delete dashboards returns "No Content" response
```
"""
Delete dashboards returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_bulk_action_data import DashboardBulkActionData
from datadog_api_client.v1.model.dashboard_bulk_action_data_list import DashboardBulkActionDataList
from datadog_api_client.v1.model.dashboard_bulk_delete_request import DashboardBulkDeleteRequest
from datadog_api_client.v1.model.dashboard_resource_type import DashboardResourceType

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

body = DashboardBulkDeleteRequest(
    data=DashboardBulkActionDataList(
        [
            DashboardBulkActionData(
                id=DASHBOARD_ID,
                type=DashboardResourceType.DASHBOARD,
            ),
        ]
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    api_instance.delete_dashboards(body=body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Delete dashboards returns "No Content" response
```
# Delete dashboards returns "No Content" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]

body = DatadogAPIClient::V1::DashboardBulkDeleteRequest.new({
  data: [
    DatadogAPIClient::V1::DashboardBulkActionData.new({
      id: DASHBOARD_ID,
      type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD,
    }),
  ],
})
api_instance.delete_dashboards(body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Delete dashboards returns "No Content" response
```
// Delete dashboards returns "No Content" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardBulkActionData;
use datadog_api_client::datadogV1::model::DashboardBulkDeleteRequest;
use datadog_api_client::datadogV1::model::DashboardResourceType;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = DashboardBulkDeleteRequest::new(vec![DashboardBulkActionData::new(
        dashboard_id.clone(),
        DashboardResourceType::DASHBOARD,
    )]);
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.delete_dashboards(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Delete dashboards returns "No Content" response
```
/**
 * Delete dashboards returns "No Content" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiDeleteDashboardsRequest = {
  body: {
    data: [
      {
        id: DASHBOARD_ID,
        type: "dashboard",
      },
    ],
  },
};

apiInstance
  .deleteDashboards(params)
  .then((data: any) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Restore deleted dashboards](https://docs.datadoghq.com/api/latest/dashboards/#restore-deleted-dashboards)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#restore-deleted-dashboards-v1)


PATCH https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.ap2.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
### Overview
Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed). This endpoint requires the `dashboards_write` permission.
OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Request
#### Body Data (required)
Restore dashboards request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Expand All
Field
Type
Description
_required_]
[object]
List of dashboard bulk action request data objects.
id [_required_]
string
Dashboard resource ID.
type [_required_]
enum
Dashboard resource type. Allowed enum values: `dashboard`
default: `dashboard`
```
{
  "data": [
    {
      "id": "123-abc-456",
      "type": "dashboard"
    }
  ]
}
```

Copy
### Response
  * [204](https://docs.datadoghq.com/api/latest/dashboards/#RestoreDashboards-204-v1)
  * [400](https://docs.datadoghq.com/api/latest/dashboards/#RestoreDashboards-400-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#RestoreDashboards-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#RestoreDashboards-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#RestoreDashboards-429-v1)


No Content
Bad Request
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Dashboards Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Restore deleted dashboards returns "No Content" response
Copy
```
                          ## json-request-body
# 
  
# Curl command  
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": [
    {
      "id": "123-abc-456",
      "type": "dashboard"
    },
    {
      "id": "789-def-101",
      "type": "dashboard"
    }
  ]
}
EOF  

                        
```

#####  Restore deleted dashboards returns "No Content" response
```
// Restore deleted dashboards returns "No Content" response

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	body := datadogV1.DashboardRestoreRequest{
		Data: []datadogV1.DashboardBulkActionData{
			{
				Id:   DashboardID,
				Type: datadogV1.DASHBOARDRESOURCETYPE_DASHBOARD,
			},
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	r, err := api.RestoreDashboards(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.RestoreDashboards`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Restore deleted dashboards returns "No Content" response
```
// Restore deleted dashboards returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardBulkActionData;
import com.datadog.api.client.v1.model.DashboardResourceType;
import com.datadog.api.client.v1.model.DashboardRestoreRequest;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    DashboardRestoreRequest body =
        new DashboardRestoreRequest()
            .data(
                Collections.singletonList(
                    new DashboardBulkActionData()
                        .id(DASHBOARD_ID)
                        .type(DashboardResourceType.DASHBOARD)));

    try {
      apiInstance.restoreDashboards(body);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#restoreDashboards");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Restore deleted dashboards returns "No Content" response
```
"""
Restore deleted dashboards returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_bulk_action_data import DashboardBulkActionData
from datadog_api_client.v1.model.dashboard_bulk_action_data_list import DashboardBulkActionDataList
from datadog_api_client.v1.model.dashboard_resource_type import DashboardResourceType
from datadog_api_client.v1.model.dashboard_restore_request import DashboardRestoreRequest

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

body = DashboardRestoreRequest(
    data=DashboardBulkActionDataList(
        [
            DashboardBulkActionData(
                id=DASHBOARD_ID,
                type=DashboardResourceType.DASHBOARD,
            ),
        ]
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    api_instance.restore_dashboards(body=body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Restore deleted dashboards returns "No Content" response
```
# Restore deleted dashboards returns "No Content" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]

body = DatadogAPIClient::V1::DashboardRestoreRequest.new({
  data: [
    DatadogAPIClient::V1::DashboardBulkActionData.new({
      id: DASHBOARD_ID,
      type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD,
    }),
  ],
})
api_instance.restore_dashboards(body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Restore deleted dashboards returns "No Content" response
```
// Restore deleted dashboards returns "No Content" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardBulkActionData;
use datadog_api_client::datadogV1::model::DashboardResourceType;
use datadog_api_client::datadogV1::model::DashboardRestoreRequest;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = DashboardRestoreRequest::new(vec![DashboardBulkActionData::new(
        dashboard_id.clone(),
        DashboardResourceType::DASHBOARD,
    )]);
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.restore_dashboards(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Restore deleted dashboards returns "No Content" response
```
/**
 * Restore deleted dashboards returns "No Content" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiRestoreDashboardsRequest = {
  body: {
    data: [
      {
        id: DASHBOARD_ID,
        type: "dashboard",
      },
    ],
  },
};

apiInstance
  .restoreDashboards(params)
  .then((data: any) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Create a shared dashboard](https://docs.datadoghq.com/api/latest/dashboards/#create-a-shared-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#create-a-shared-dashboard-v1)


POST https://api.ap1.datadoghq.com/api/v1/dashboard/publichttps://api.ap2.datadoghq.com/api/v1/dashboard/publichttps://api.datadoghq.eu/api/v1/dashboard/publichttps://api.ddog-gov.com/api/v1/dashboard/publichttps://api.datadoghq.com/api/v1/dashboard/publichttps://api.us3.datadoghq.com/api/v1/dashboard/publichttps://api.us5.datadoghq.com/api/v1/dashboard/public
### Overview
Share a specified private dashboard, generating a URL at which it can be publicly viewed. This endpoint requires any of the following permissions:
* `dashboards_public_share`
* `dashboards_embed_share`
* `dashboards_invite_share`
  

OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Request
#### Body Data (required)
Create a shared dashboard request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Expand All
Field
Type
Description
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created
date-time
Date the dashboard was shared.
dashboard_id [_required_]
string
ID of the dashboard to share.
dashboard_type [_required_]
enum
The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard`
embeddable_domains
[string]
The `SharedDashboard` `embeddable_domains`.
expiration
date-time
The time when an OPEN shared dashboard becomes publicly unavailable.
object
Object containing the live span selection for the dashboard.
live_span
enum
Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo`
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
[object]
The `SharedDashboard` `invitees`.
access_expiration
date-time
Time of the invitee expiration. Null means the invite will not expire.
created_at
date-time
Time that the invitee was created.
email [_required_]
string
Email of the invitee.
last_accessed
date-time
The last time the shared dashboard was accessed. Null if never accessed.
public_url
string
URL of the shared dashboard.
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
**DEPRECATED** : List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed`
status
enum
Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused`
title
string
Title of the shared dashboard.
token
string
A unique token assigned to the shared dashboard.
object
The viewing preferences for a shared dashboard.
high_density
boolean
Whether the widgets on the shared dashboard should be displayed with high density.
theme
enum
The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark`
#####  Create a shared dashboard returns "OK" response
```
{
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "share_type": "open",
  "global_time": {
    "live_span": "1h"
  }
}
```

Copy
#####  Create a shared dashboard with a group template variable returns "OK" response
```
{
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "share_type": "open",
  "global_time": {
    "live_span": "1h"
  },
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
```

Copy
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#CreatePublicDashboard-200-v1)
  * [400](https://docs.datadoghq.com/api/latest/dashboards/#CreatePublicDashboard-400-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#CreatePublicDashboard-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#CreatePublicDashboard-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#CreatePublicDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


The metadata object associated with how a dashboard has been/will be shared.
Expand All
Field
Type
Description
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created
date-time
Date the dashboard was shared.
dashboard_id [_required_]
string
ID of the dashboard to share.
dashboard_type [_required_]
enum
The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard`
embeddable_domains
[string]
The `SharedDashboard` `embeddable_domains`.
expiration
date-time
The time when an OPEN shared dashboard becomes publicly unavailable.
object
Object containing the live span selection for the dashboard.
live_span
enum
Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo`
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
[object]
The `SharedDashboard` `invitees`.
access_expiration
date-time
Time of the invitee expiration. Null means the invite will not expire.
created_at
date-time
Time that the invitee was created.
email [_required_]
string
Email of the invitee.
last_accessed
date-time
The last time the shared dashboard was accessed. Null if never accessed.
public_url
string
URL of the shared dashboard.
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
**DEPRECATED** : List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed`
status
enum
Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused`
title
string
Title of the shared dashboard.
token
string
A unique token assigned to the shared dashboard.
object
The viewing preferences for a shared dashboard.
high_density
boolean
Whether the widgets on the shared dashboard should be displayed with high density.
theme
enum
The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark`
```
{
  "author": {
    "handle": "test@datadoghq.com",
    "name": "string"
  },
  "created": "2019-09-19T10:00:00.000Z",
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "embeddable_domains": [
    "https://domain.atlassian.net/",
    "http://myserver.com/"
  ],
  "expiration": "2019-09-19T10:00:00.000Z",
  "global_time": {
    "live_span": "1h"
  },
  "global_time_selectable_enabled": false,
  "invitees": [
    {
      "access_expiration": "2019-09-19T10:00:00.000Z",
      "created_at": "2019-09-19T10:00:00.000Z",
      "email": "test@datadoghq.com"
    }
  ],
  "last_accessed": "2019-09-19T10:00:00.000Z",
  "public_url": "string",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "exampleVar",
      "prefix": "test",
      "type": "string",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ],
  "share_list": [
    "test@datadoghq.com",
    "test2@email.com"
  ],
  "share_type": "string",
  "status": "active",
  "title": "string",
  "token": "string",
  "viewing_preferences": {
    "high_density": false,
    "theme": "string"
  }
}
```

Copy
Bad Request
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Dashboard Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Create a shared dashboard returns "OK" response
Copy
```
                          ## json-request-body
# 
  
# Curl command  
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "share_type": "open"
}
EOF  

                        
```

#####  Create a shared dashboard with a group template variable returns "OK" response
Copy
```
                          ## json-request-body
# 
  
# Curl command  
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "share_type": "open"
}
EOF  

                        
```

#####  Create a shared dashboard returns "OK" response 
```
// Create a shared dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	body := datadogV1.SharedDashboard{
		DashboardId:   DashboardID,
		DashboardType: datadogV1.DASHBOARDTYPE_CUSTOM_TIMEBOARD,
		ShareType:     *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),
		GlobalTime: &datadogV1.DashboardGlobalTime{
			LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(),
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.CreatePublicDashboard(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreatePublicDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreatePublicDashboard`:\n%s\n", responseContent)
}

```

Copy
#####  Create a shared dashboard with a group template variable returns "OK" response 
```
// Create a shared dashboard with a group template variable returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "dashboard" in the system
	DashboardID := os.Getenv("DASHBOARD_ID")

	body := datadogV1.SharedDashboard{
		DashboardId:   DashboardID,
		DashboardType: datadogV1.DASHBOARDTYPE_CUSTOM_TIMEBOARD,
		ShareType:     *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),
		GlobalTime: &datadogV1.DashboardGlobalTime{
			LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(),
		},
		SelectableTemplateVars: []datadogV1.SelectableTemplateVariableItems{
			{
				DefaultValue: datadog.PtrString("*"),
				Name:         datadog.PtrString("group_by_var"),
				Type:         *datadog.NewNullableString(datadog.PtrString("group")),
				VisibleTags: *datadog.NewNullableList(&[]string{
					"selectableValue1",
					"selectableValue2",
				}),
			},
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.CreatePublicDashboard(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreatePublicDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreatePublicDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Create a shared dashboard returns "OK" response 
```
// Create a shared dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardGlobalTime;
import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
import com.datadog.api.client.v1.model.DashboardShareType;
import com.datadog.api.client.v1.model.DashboardType;
import com.datadog.api.client.v1.model.SharedDashboard;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    SharedDashboard body =
        new SharedDashboard()
            .dashboardId(DASHBOARD_ID)
            .dashboardType(DashboardType.CUSTOM_TIMEBOARD)
            .shareType(DashboardShareType.OPEN)
            .globalTime(
                new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR));

    try {
      SharedDashboard result = apiInstance.createPublicDashboard(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#createPublicDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#####  Create a shared dashboard with a group template variable returns "OK" response 
```
// Create a shared dashboard with a group template variable returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardGlobalTime;
import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
import com.datadog.api.client.v1.model.DashboardShareType;
import com.datadog.api.client.v1.model.DashboardType;
import com.datadog.api.client.v1.model.SelectableTemplateVariableItems;
import com.datadog.api.client.v1.model.SharedDashboard;
import java.util.Arrays;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "dashboard" in the system
    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");

    SharedDashboard body =
        new SharedDashboard()
            .dashboardId(DASHBOARD_ID)
            .dashboardType(DashboardType.CUSTOM_TIMEBOARD)
            .shareType(DashboardShareType.OPEN)
            .globalTime(
                new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR))
            .selectableTemplateVars(
                Collections.singletonList(
                    new SelectableTemplateVariableItems()
                        .defaultValue("*")
                        .name("group_by_var")
                        .type("group")
                        .visibleTags(Arrays.asList("selectableValue1", "selectableValue2"))));

    try {
      SharedDashboard result = apiInstance.createPublicDashboard(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#createPublicDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Create a shared dashboard returns "OK" response 
```
"""
Create a shared dashboard returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_global_time import DashboardGlobalTime
from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan
from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType
from datadog_api_client.v1.model.dashboard_type import DashboardType
from datadog_api_client.v1.model.shared_dashboard import SharedDashboard

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

body = SharedDashboard(
    dashboard_id=DASHBOARD_ID,
    dashboard_type=DashboardType.CUSTOM_TIMEBOARD,
    share_type=DashboardShareType.OPEN,
    global_time=DashboardGlobalTime(
        live_span=DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR,
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.create_public_dashboard(body=body)

    print(response)

```

Copy
#####  Create a shared dashboard with a group template variable returns "OK" response 
```
"""
Create a shared dashboard with a group template variable returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_global_time import DashboardGlobalTime
from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan
from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType
from datadog_api_client.v1.model.dashboard_type import DashboardType
from datadog_api_client.v1.model.selectable_template_variable_items import SelectableTemplateVariableItems
from datadog_api_client.v1.model.shared_dashboard import SharedDashboard

# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]

body = SharedDashboard(
    dashboard_id=DASHBOARD_ID,
    dashboard_type=DashboardType.CUSTOM_TIMEBOARD,
    share_type=DashboardShareType.OPEN,
    global_time=DashboardGlobalTime(
        live_span=DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR,
    ),
    selectable_template_vars=[
        SelectableTemplateVariableItems(
            default_value="*",
            name="group_by_var",
            type="group",
            visible_tags=[
                "selectableValue1",
                "selectableValue2",
            ],
        ),
    ],
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.create_public_dashboard(body=body)

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Create a shared dashboard returns "OK" response 
```
# Create a shared dashboard returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]

body = DatadogAPIClient::V1::SharedDashboard.new({
  dashboard_id: DASHBOARD_ID,
  dashboard_type: DatadogAPIClient::V1::DashboardType::CUSTOM_TIMEBOARD,
  share_type: DatadogAPIClient::V1::DashboardShareType::OPEN,
  global_time: DatadogAPIClient::V1::DashboardGlobalTime.new({
    live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR,
  }),
})
p api_instance.create_public_dashboard(body)

```

Copy
#####  Create a shared dashboard with a group template variable returns "OK" response 
```
# Create a shared dashboard with a group template variable returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]

body = DatadogAPIClient::V1::SharedDashboard.new({
  dashboard_id: DASHBOARD_ID,
  dashboard_type: DatadogAPIClient::V1::DashboardType::CUSTOM_TIMEBOARD,
  share_type: DatadogAPIClient::V1::DashboardShareType::OPEN,
  global_time: DatadogAPIClient::V1::DashboardGlobalTime.new({
    live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR,
  }),
  selectable_template_vars: [
    DatadogAPIClient::V1::SelectableTemplateVariableItems.new({
      default_value: "*",
      name: "group_by_var",
      type: "group",
      visible_tags: [
        "selectableValue1",
        "selectableValue2",
      ],
    }),
  ],
})
p api_instance.create_public_dashboard(body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Create a shared dashboard returns "OK" response 
```
// Create a shared dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardGlobalTime;
use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;
use datadog_api_client::datadogV1::model::DashboardShareType;
use datadog_api_client::datadogV1::model::DashboardType;
use datadog_api_client::datadogV1::model::SharedDashboard;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#####  Create a shared dashboard with a group template variable returns "OK" response 
```
// Create a shared dashboard with a group template variable returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardGlobalTime;
use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;
use datadog_api_client::datadogV1::model::DashboardShareType;
use datadog_api_client::datadogV1::model::DashboardType;
use datadog_api_client::datadogV1::model::SelectableTemplateVariableItems;
use datadog_api_client::datadogV1::model::SharedDashboard;

#[tokio::main]
async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new()
            .default_value("*".to_string())
            .name("group_by_var".to_string())
            .type_(Some("group".to_string()))
            .visible_tags(Some(vec![
                "selectableValue1".to_string(),
                "selectableValue2".to_string(),
            ]))]))
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Create a shared dashboard returns "OK" response 
```
/**
 * Create a shared dashboard returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiCreatePublicDashboardRequest = {
  body: {
    dashboardId: DASHBOARD_ID,
    dashboardType: "custom_timeboard",
    shareType: "open",
    globalTime: {
      liveSpan: "1h",
    },
  },
};

apiInstance
  .createPublicDashboard(params)
  .then((data: v1.SharedDashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#####  Create a shared dashboard with a group template variable returns "OK" response 
```
/**
 * Create a shared dashboard with a group template variable returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;

const params: v1.DashboardsApiCreatePublicDashboardRequest = {
  body: {
    dashboardId: DASHBOARD_ID,
    dashboardType: "custom_timeboard",
    shareType: "open",
    globalTime: {
      liveSpan: "1h",
    },
    selectableTemplateVars: [
      {
        defaultValue: "*",
        name: "group_by_var",
        type: "group",
        visibleTags: ["selectableValue1", "selectableValue2"],
      },
    ],
  },
};

apiInstance
  .createPublicDashboard(params)
  .then((data: v1.SharedDashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Get a shared dashboard](https://docs.datadoghq.com/api/latest/dashboards/#get-a-shared-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#get-a-shared-dashboard-v1)


GET https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}https://api.datadoghq.eu/api/v1/dashboard/public/{token}https://api.ddog-gov.com/api/v1/dashboard/public/{token}https://api.datadoghq.com/api/v1/dashboard/public/{token}https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}
### Overview
Fetch an existing shared dashboard’s sharing metadata associated with the specified token. This endpoint requires the `dashboards_read` permission.
OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
token [_required_]
string
The token of the shared dashboard. Generated when a dashboard is shared.
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboard-200-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboard-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboard-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


The metadata object associated with how a dashboard has been/will be shared.
Expand All
Field
Type
Description
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created
date-time
Date the dashboard was shared.
dashboard_id [_required_]
string
ID of the dashboard to share.
dashboard_type [_required_]
enum
The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard`
embeddable_domains
[string]
The `SharedDashboard` `embeddable_domains`.
expiration
date-time
The time when an OPEN shared dashboard becomes publicly unavailable.
object
Object containing the live span selection for the dashboard.
live_span
enum
Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo`
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
[object]
The `SharedDashboard` `invitees`.
access_expiration
date-time
Time of the invitee expiration. Null means the invite will not expire.
created_at
date-time
Time that the invitee was created.
email [_required_]
string
Email of the invitee.
last_accessed
date-time
The last time the shared dashboard was accessed. Null if never accessed.
public_url
string
URL of the shared dashboard.
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
**DEPRECATED** : List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed`
status
enum
Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused`
title
string
Title of the shared dashboard.
token
string
A unique token assigned to the shared dashboard.
object
The viewing preferences for a shared dashboard.
high_density
boolean
Whether the widgets on the shared dashboard should be displayed with high density.
theme
enum
The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark`
```
{
  "author": {
    "handle": "test@datadoghq.com",
    "name": "string"
  },
  "created": "2019-09-19T10:00:00.000Z",
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "embeddable_domains": [
    "https://domain.atlassian.net/",
    "http://myserver.com/"
  ],
  "expiration": "2019-09-19T10:00:00.000Z",
  "global_time": {
    "live_span": "1h"
  },
  "global_time_selectable_enabled": false,
  "invitees": [
    {
      "access_expiration": "2019-09-19T10:00:00.000Z",
      "created_at": "2019-09-19T10:00:00.000Z",
      "email": "test@datadoghq.com"
    }
  ],
  "last_accessed": "2019-09-19T10:00:00.000Z",
  "public_url": "string",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "exampleVar",
      "prefix": "test",
      "type": "string",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ],
  "share_list": [
    "test@datadoghq.com",
    "test2@email.com"
  ],
  "share_type": "string",
  "status": "active",
  "title": "string",
  "token": "string",
  "viewing_preferences": {
    "high_density": false,
    "theme": "string"
  }
}
```

Copy
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Shared Dashboard Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Get a shared dashboard
Copy
```
                  # Path parameters  
export token="CHANGE_ME"  
# Curl command  
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"  

                
```

#####  Get a shared dashboard
```
"""
Get a shared dashboard returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.get_public_dashboard(
        token=SHARED_DASHBOARD_TOKEN,
    )

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Get a shared dashboard
```
# Get a shared dashboard returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"]
p api_instance.get_public_dashboard(SHARED_DASHBOARD_TOKEN)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Get a shared dashboard
```
// Get a shared dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "shared_dashboard" in the system
	SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN")

	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.GetPublicDashboard(ctx, SharedDashboardToken)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.GetPublicDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.GetPublicDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Get a shared dashboard
```
// Get a shared dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.SharedDashboard;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "shared_dashboard" in the system
    String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN");

    try {
      SharedDashboard result = apiInstance.getPublicDashboard(SHARED_DASHBOARD_TOKEN);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#getPublicDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Get a shared dashboard
```
// Get a shared dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;

#[tokio::main]
async fn main() {
    // there is a valid "shared_dashboard" in the system
    let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .get_public_dashboard(shared_dashboard_token.clone())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Get a shared dashboard
```
/**
 * Get a shared dashboard returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "shared_dashboard" in the system
const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string;

const params: v1.DashboardsApiGetPublicDashboardRequest = {
  token: SHARED_DASHBOARD_TOKEN,
};

apiInstance
  .getPublicDashboard(params)
  .then((data: v1.SharedDashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Update a shared dashboard](https://docs.datadoghq.com/api/latest/dashboards/#update-a-shared-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#update-a-shared-dashboard-v1)


PUT https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}https://api.datadoghq.eu/api/v1/dashboard/public/{token}https://api.ddog-gov.com/api/v1/dashboard/public/{token}https://api.datadoghq.com/api/v1/dashboard/public/{token}https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}
### Overview
Update a shared dashboard associated with the specified token. This endpoint requires any of the following permissions:
* `dashboards_public_share`
* `dashboards_embed_share`
* `dashboards_invite_share`
  

OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
token [_required_]
string
The token of the shared dashboard.
### Request
#### Body Data (required)
Update Dashboard request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Expand All
Field
Type
Description
embeddable_domains
[string]
The `SharedDashboard` `embeddable_domains`.
expiration
date-time
The time when an OPEN shared dashboard becomes publicly unavailable.
object
Timeframe setting for the shared dashboard.
live_span
enum
Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo`
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
[object]
The `SharedDashboard` `invitees`.
access_expiration
date-time
Time of the invitee expiration. Null means the invite will not expire.
created_at
date-time
Time that the invitee was created.
email [_required_]
string
Email of the invitee.
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
**DEPRECATED** : List of email addresses that can be given access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed`
status
enum
Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused`
title
string
Title of the shared dashboard.
object
The viewing preferences for a shared dashboard.
high_density
boolean
Whether the widgets on the shared dashboard should be displayed with high density.
theme
enum
The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark`
#####  Update a shared dashboard returns "OK" response
```
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
```

Copy
#####  Update a shared dashboard with selectable_template_vars returns "OK" response
```
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
```

Copy
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#UpdatePublicDashboard-200-v1)
  * [400](https://docs.datadoghq.com/api/latest/dashboards/#UpdatePublicDashboard-400-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#UpdatePublicDashboard-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#UpdatePublicDashboard-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#UpdatePublicDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


The metadata object associated with how a dashboard has been/will be shared.
Expand All
Field
Type
Description
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created
date-time
Date the dashboard was shared.
dashboard_id [_required_]
string
ID of the dashboard to share.
dashboard_type [_required_]
enum
The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard`
embeddable_domains
[string]
The `SharedDashboard` `embeddable_domains`.
expiration
date-time
The time when an OPEN shared dashboard becomes publicly unavailable.
object
Object containing the live span selection for the dashboard.
live_span
enum
Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo`
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
[object]
The `SharedDashboard` `invitees`.
access_expiration
date-time
Time of the invitee expiration. Null means the invite will not expire.
created_at
date-time
Time that the invitee was created.
email [_required_]
string
Email of the invitee.
last_accessed
date-time
The last time the shared dashboard was accessed. Null if never accessed.
public_url
string
URL of the shared dashboard.
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
**DEPRECATED** : List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed`
status
enum
Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused`
title
string
Title of the shared dashboard.
token
string
A unique token assigned to the shared dashboard.
object
The viewing preferences for a shared dashboard.
high_density
boolean
Whether the widgets on the shared dashboard should be displayed with high density.
theme
enum
The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark`
```
{
  "author": {
    "handle": "test@datadoghq.com",
    "name": "string"
  },
  "created": "2019-09-19T10:00:00.000Z",
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "embeddable_domains": [
    "https://domain.atlassian.net/",
    "http://myserver.com/"
  ],
  "expiration": "2019-09-19T10:00:00.000Z",
  "global_time": {
    "live_span": "1h"
  },
  "global_time_selectable_enabled": false,
  "invitees": [
    {
      "access_expiration": "2019-09-19T10:00:00.000Z",
      "created_at": "2019-09-19T10:00:00.000Z",
      "email": "test@datadoghq.com"
    }
  ],
  "last_accessed": "2019-09-19T10:00:00.000Z",
  "public_url": "string",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "exampleVar",
      "prefix": "test",
      "type": "string",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ],
  "share_list": [
    "test@datadoghq.com",
    "test2@email.com"
  ],
  "share_type": "string",
  "status": "active",
  "title": "string",
  "token": "string",
  "viewing_preferences": {
    "high_density": false,
    "theme": "string"
  }
}
```

Copy
Bad Request
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Authentication Error
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Item Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Update a shared dashboard returns "OK" response
Copy
```
                          ## json-request-body
# 
  
# Path parameters  
export token="CHANGE_ME"  
# Curl command  
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "1h"
  },
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "exampleVar",
      "prefix": "test",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ],
  "share_list": [
    "test@datadoghq.com",
    "test2@datadoghq.com"
  ],
  "share_type": "invite"
}
EOF  

                        
```

#####  Update a shared dashboard with selectable_template_vars returns "OK" response
Copy
```
                          ## json-request-body
# 
  
# Path parameters  
export token="CHANGE_ME"  
# Curl command  
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "1h"
  },
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "exampleVar",
      "prefix": "test",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ],
  "share_list": [
    "test@datadoghq.com",
    "test2@datadoghq.com"
  ],
  "share_type": "invite"
}
EOF  

                        
```

#####  Update a shared dashboard returns "OK" response 
```
// Update a shared dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "shared_dashboard" in the system
	SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN")

	body := datadogV1.SharedDashboardUpdateRequest{
		GlobalTime: *datadogV1.NewNullableSharedDashboardUpdateRequestGlobalTime(&datadogV1.SharedDashboardUpdateRequestGlobalTime{
			LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_FIFTEEN_MINUTES.Ptr(),
		}),
		ShareList: *datadog.NewNullableList(&[]string{}),
		ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.UpdatePublicDashboard(ctx, SharedDashboardToken, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdatePublicDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdatePublicDashboard`:\n%s\n", responseContent)
}

```

Copy
#####  Update a shared dashboard with selectable_template_vars returns "OK" response 
```
// Update a shared dashboard with selectable_template_vars returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "shared_dashboard" in the system
	SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN")

	body := datadogV1.SharedDashboardUpdateRequest{
		GlobalTime: *datadogV1.NewNullableSharedDashboardUpdateRequestGlobalTime(&datadogV1.SharedDashboardUpdateRequestGlobalTime{
			LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_FIFTEEN_MINUTES.Ptr(),
		}),
		ShareList: *datadog.NewNullableList(&[]string{}),
		ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),
		SelectableTemplateVars: []datadogV1.SelectableTemplateVariableItems{
			{
				DefaultValue: datadog.PtrString("*"),
				Name:         datadog.PtrString("group_by_var"),
				Type:         *datadog.NewNullableString(datadog.PtrString("group")),
				VisibleTags: *datadog.NewNullableList(&[]string{
					"selectableValue1",
					"selectableValue2",
				}),
			},
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.UpdatePublicDashboard(ctx, SharedDashboardToken, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdatePublicDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdatePublicDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Update a shared dashboard returns "OK" response 
```
// Update a shared dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
import com.datadog.api.client.v1.model.DashboardShareType;
import com.datadog.api.client.v1.model.SharedDashboard;
import com.datadog.api.client.v1.model.SharedDashboardUpdateRequest;
import com.datadog.api.client.v1.model.SharedDashboardUpdateRequestGlobalTime;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "shared_dashboard" in the system
    String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN");

    SharedDashboardUpdateRequest body =
        new SharedDashboardUpdateRequest()
            .globalTime(
                new SharedDashboardUpdateRequestGlobalTime()
                    .liveSpan(DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES))
            .shareType(DashboardShareType.OPEN);

    try {
      SharedDashboard result = apiInstance.updatePublicDashboard(SHARED_DASHBOARD_TOKEN, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#updatePublicDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#####  Update a shared dashboard with selectable_template_vars returns "OK" response 
```
// Update a shared dashboard with selectable_template_vars returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
import com.datadog.api.client.v1.model.DashboardShareType;
import com.datadog.api.client.v1.model.SelectableTemplateVariableItems;
import com.datadog.api.client.v1.model.SharedDashboard;
import com.datadog.api.client.v1.model.SharedDashboardUpdateRequest;
import com.datadog.api.client.v1.model.SharedDashboardUpdateRequestGlobalTime;
import java.util.Arrays;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "shared_dashboard" in the system
    String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN");

    SharedDashboardUpdateRequest body =
        new SharedDashboardUpdateRequest()
            .globalTime(
                new SharedDashboardUpdateRequestGlobalTime()
                    .liveSpan(DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES))
            .shareType(DashboardShareType.OPEN)
            .selectableTemplateVars(
                Collections.singletonList(
                    new SelectableTemplateVariableItems()
                        .defaultValue("*")
                        .name("group_by_var")
                        .type("group")
                        .visibleTags(Arrays.asList("selectableValue1", "selectableValue2"))));

    try {
      SharedDashboard result = apiInstance.updatePublicDashboard(SHARED_DASHBOARD_TOKEN, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#updatePublicDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Update a shared dashboard returns "OK" response 
```
"""
Update a shared dashboard returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan
from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType
from datadog_api_client.v1.model.shared_dashboard_update_request import SharedDashboardUpdateRequest
from datadog_api_client.v1.model.shared_dashboard_update_request_global_time import (
    SharedDashboardUpdateRequestGlobalTime,
)

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"]

body = SharedDashboardUpdateRequest(
    global_time=SharedDashboardUpdateRequestGlobalTime(
        live_span=DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES,
    ),
    share_list=[],
    share_type=DashboardShareType.OPEN,
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.update_public_dashboard(token=SHARED_DASHBOARD_TOKEN, body=body)

    print(response)

```

Copy
#####  Update a shared dashboard with selectable_template_vars returns "OK" response 
```
"""
Update a shared dashboard with selectable_template_vars returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan
from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType
from datadog_api_client.v1.model.selectable_template_variable_items import SelectableTemplateVariableItems
from datadog_api_client.v1.model.shared_dashboard_update_request import SharedDashboardUpdateRequest
from datadog_api_client.v1.model.shared_dashboard_update_request_global_time import (
    SharedDashboardUpdateRequestGlobalTime,
)

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"]

body = SharedDashboardUpdateRequest(
    global_time=SharedDashboardUpdateRequestGlobalTime(
        live_span=DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES,
    ),
    share_list=[],
    share_type=DashboardShareType.OPEN,
    selectable_template_vars=[
        SelectableTemplateVariableItems(
            default_value="*",
            name="group_by_var",
            type="group",
            visible_tags=[
                "selectableValue1",
                "selectableValue2",
            ],
        ),
    ],
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.update_public_dashboard(token=SHARED_DASHBOARD_TOKEN, body=body)

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Update a shared dashboard returns "OK" response 
```
# Update a shared dashboard returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"]

body = DatadogAPIClient::V1::SharedDashboardUpdateRequest.new({
  global_time: DatadogAPIClient::V1::SharedDashboardUpdateRequestGlobalTime.new({
    live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES,
  }),
  share_list: [],
  share_type: DatadogAPIClient::V1::DashboardShareType::OPEN,
})
p api_instance.update_public_dashboard(SHARED_DASHBOARD_TOKEN, body)

```

Copy
#####  Update a shared dashboard with selectable_template_vars returns "OK" response 
```
# Update a shared dashboard with selectable_template_vars returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"]

body = DatadogAPIClient::V1::SharedDashboardUpdateRequest.new({
  global_time: DatadogAPIClient::V1::SharedDashboardUpdateRequestGlobalTime.new({
    live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES,
  }),
  share_list: [],
  share_type: DatadogAPIClient::V1::DashboardShareType::OPEN,
  selectable_template_vars: [
    DatadogAPIClient::V1::SelectableTemplateVariableItems.new({
      default_value: "*",
      name: "group_by_var",
      type: "group",
      visible_tags: [
        "selectableValue1",
        "selectableValue2",
      ],
    }),
  ],
})
p api_instance.update_public_dashboard(SHARED_DASHBOARD_TOKEN, body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Update a shared dashboard returns "OK" response 
```
// Update a shared dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;
use datadog_api_client::datadogV1::model::DashboardShareType;
use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequest;
use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequestGlobalTime;

#[tokio::main]
async fn main() {
    // there is a valid "shared_dashboard" in the system
    let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();
    let body = SharedDashboardUpdateRequest::new()
        .global_time(Some(
            SharedDashboardUpdateRequestGlobalTime::new()
                .live_span(DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES),
        ))
        .share_list(Some(vec![]))
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .update_public_dashboard(shared_dashboard_token.clone(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#####  Update a shared dashboard with selectable_template_vars returns "OK" response 
```
// Update a shared dashboard with selectable_template_vars returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;
use datadog_api_client::datadogV1::model::DashboardShareType;
use datadog_api_client::datadogV1::model::SelectableTemplateVariableItems;
use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequest;
use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequestGlobalTime;

#[tokio::main]
async fn main() {
    // there is a valid "shared_dashboard" in the system
    let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();
    let body = SharedDashboardUpdateRequest::new()
        .global_time(Some(
            SharedDashboardUpdateRequestGlobalTime::new()
                .live_span(DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES),
        ))
        .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new()
            .default_value("*".to_string())
            .name("group_by_var".to_string())
            .type_(Some("group".to_string()))
            .visible_tags(Some(vec![
                "selectableValue1".to_string(),
                "selectableValue2".to_string(),
            ]))]))
        .share_list(Some(vec![]))
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .update_public_dashboard(shared_dashboard_token.clone(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Update a shared dashboard returns "OK" response 
```
/**
 * Update a shared dashboard returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "shared_dashboard" in the system
const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string;

const params: v1.DashboardsApiUpdatePublicDashboardRequest = {
  body: {
    globalTime: {
      liveSpan: "15m",
    },
    shareList: [],
    shareType: "open",
  },
  token: SHARED_DASHBOARD_TOKEN,
};

apiInstance
  .updatePublicDashboard(params)
  .then((data: v1.SharedDashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#####  Update a shared dashboard with selectable_template_vars returns "OK" response 
```
/**
 * Update a shared dashboard with selectable_template_vars returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "shared_dashboard" in the system
const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string;

const params: v1.DashboardsApiUpdatePublicDashboardRequest = {
  body: {
    globalTime: {
      liveSpan: "15m",
    },
    shareList: [],
    shareType: "open",
    selectableTemplateVars: [
      {
        defaultValue: "*",
        name: "group_by_var",
        type: "group",
        visibleTags: ["selectableValue1", "selectableValue2"],
      },
    ],
  },
  token: SHARED_DASHBOARD_TOKEN,
};

apiInstance
  .updatePublicDashboard(params)
  .then((data: v1.SharedDashboard) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Send shared dashboard invitation email](https://docs.datadoghq.com/api/latest/dashboards/#send-shared-dashboard-invitation-email)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#send-shared-dashboard-invitation-email-v1)


POST https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitationhttps://api.ddog-gov.com/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.us3.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.us5.datadoghq.com/api/v1/dashboard/public/{token}/invitation
### Overview
Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard’s share_list. This endpoint requires the `dashboards_invite_share` permission.
OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
token [_required_]
string
The token of the shared dashboard.
### Request
#### Body Data (required)
Shared Dashboard Invitation request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Expand All
Field
Type
Description
_required_]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
object
Object containing the information for an invitation to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
object
Pagination metadata returned by the API.
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
```
{
  "data": {
    "attributes": {
      "email": "exampledashboard@datadoghq.com"
    },
    "type": "public_dashboard_invitation"
  }
}
```

Copy
### Response
  * [201](https://docs.datadoghq.com/api/latest/dashboards/#SendPublicDashboardInvitation-201-v1)
  * [400](https://docs.datadoghq.com/api/latest/dashboards/#SendPublicDashboardInvitation-400-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#SendPublicDashboardInvitation-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#SendPublicDashboardInvitation-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#SendPublicDashboardInvitation-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Invitations data and metadata that exists for a shared dashboard returned by the API.
Expand All
Field
Type
Description
_required_]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
object
Object containing the information for an invitation to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
object
Pagination metadata returned by the API.
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
```
{
  "data": [
    {
      "attributes": {
        "email": "test@datadoghq.com"
      },
      "type": "public_dashboard_invitation"
    }
  ]
}
```

Copy
Bad Request
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Send shared dashboard invitation email returns "OK" response
Copy
```
                          ## json-request-body
# 
  
# Path parameters  
export token="CHANGE_ME"  
# Curl command  
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": [
    {
      "attributes": {
        "email": "test@datadoghq.com"
      },
      "type": "public_dashboard_invitation"
    }
  ]
}
EOF  

                        
```

#####  Send shared dashboard invitation email returns "OK" response
```
// Send shared dashboard invitation email returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "shared_dashboard" in the system
	SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN")

	body := datadogV1.SharedDashboardInvites{
		Data: datadogV1.SharedDashboardInvitesData{
			SharedDashboardInvitesDataObject: &datadogV1.SharedDashboardInvitesDataObject{
				Attributes: datadogV1.SharedDashboardInvitesDataObjectAttributes{
					Email: datadog.PtrString("exampledashboard@datadoghq.com"),
				},
				Type: datadogV1.DASHBOARDINVITETYPE_PUBLIC_DASHBOARD_INVITATION,
			}},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.SendPublicDashboardInvitation(ctx, SharedDashboardToken, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.SendPublicDashboardInvitation`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.SendPublicDashboardInvitation`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Send shared dashboard invitation email returns "OK" response
```
// Send shared dashboard invitation email returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardInviteType;
import com.datadog.api.client.v1.model.SharedDashboardInvites;
import com.datadog.api.client.v1.model.SharedDashboardInvitesData;
import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObject;
import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObjectAttributes;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "shared_dashboard" in the system
    String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN");

    SharedDashboardInvites body =
        new SharedDashboardInvites()
            .data(
                new SharedDashboardInvitesData(
                    new SharedDashboardInvitesDataObject()
                        .attributes(
                            new SharedDashboardInvitesDataObjectAttributes()
                                .email("exampledashboard@datadoghq.com"))
                        .type(DashboardInviteType.PUBLIC_DASHBOARD_INVITATION)));

    try {
      SharedDashboardInvites result =
          apiInstance.sendPublicDashboardInvitation(SHARED_DASHBOARD_TOKEN, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#sendPublicDashboardInvitation");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Send shared dashboard invitation email returns "OK" response
```
"""
Send shared dashboard invitation email returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_invite_type import DashboardInviteType
from datadog_api_client.v1.model.shared_dashboard_invites import SharedDashboardInvites
from datadog_api_client.v1.model.shared_dashboard_invites_data_object import SharedDashboardInvitesDataObject
from datadog_api_client.v1.model.shared_dashboard_invites_data_object_attributes import (
    SharedDashboardInvitesDataObjectAttributes,
)

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"]

body = SharedDashboardInvites(
    data=SharedDashboardInvitesDataObject(
        attributes=SharedDashboardInvitesDataObjectAttributes(
            email="exampledashboard@datadoghq.com",
        ),
        type=DashboardInviteType.PUBLIC_DASHBOARD_INVITATION,
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.send_public_dashboard_invitation(token=SHARED_DASHBOARD_TOKEN, body=body)

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Send shared dashboard invitation email returns "OK" response
```
# Send shared dashboard invitation email returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"]

body = DatadogAPIClient::V1::SharedDashboardInvites.new({
  data: DatadogAPIClient::V1::SharedDashboardInvitesDataObject.new({
    attributes: DatadogAPIClient::V1::SharedDashboardInvitesDataObjectAttributes.new({
      email: "exampledashboard@datadoghq.com",
    }),
    type: DatadogAPIClient::V1::DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,
  }),
})
p api_instance.send_public_dashboard_invitation(SHARED_DASHBOARD_TOKEN, body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Send shared dashboard invitation email returns "OK" response
```
// Send shared dashboard invitation email returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardInviteType;
use datadog_api_client::datadogV1::model::SharedDashboardInvites;
use datadog_api_client::datadogV1::model::SharedDashboardInvitesData;
use datadog_api_client::datadogV1::model::SharedDashboardInvitesDataObject;
use datadog_api_client::datadogV1::model::SharedDashboardInvitesDataObjectAttributes;

#[tokio::main]
async fn main() {
    // there is a valid "shared_dashboard" in the system
    let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();
    let body = SharedDashboardInvites::new(
        SharedDashboardInvitesData::SharedDashboardInvitesDataObject(Box::new(
            SharedDashboardInvitesDataObject::new(
                SharedDashboardInvitesDataObjectAttributes::new()
                    .email("exampledashboard@datadoghq.com".to_string()),
                DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,
            ),
        )),
    );
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .send_public_dashboard_invitation(shared_dashboard_token.clone(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Send shared dashboard invitation email returns "OK" response
```
/**
 * Send shared dashboard invitation email returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "shared_dashboard" in the system
const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string;

const params: v1.DashboardsApiSendPublicDashboardInvitationRequest = {
  body: {
    data: {
      attributes: {
        email: "exampledashboard@datadoghq.com",
      },
      type: "public_dashboard_invitation",
    },
  },
  token: SHARED_DASHBOARD_TOKEN,
};

apiInstance
  .sendPublicDashboardInvitation(params)
  .then((data: v1.SharedDashboardInvites) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Get all invitations for a shared dashboard](https://docs.datadoghq.com/api/latest/dashboards/#get-all-invitations-for-a-shared-dashboard)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#get-all-invitations-for-a-shared-dashboard-v1)


GET https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitationhttps://api.ddog-gov.com/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.us3.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.us5.datadoghq.com/api/v1/dashboard/public/{token}/invitation
### Overview
Describe the invitations that exist for the given shared dashboard (paginated). This endpoint requires the `dashboards_invite_share` permission.
OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
token [_required_]
string
Token of the shared dashboard for which to fetch invitations.
#### Query Strings
Name
Type
Description
page_size
integer
The number of records to return in a single request.
page_number
integer
The page to access (base 0).
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboardInvitations-200-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboardInvitations-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboardInvitations-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#GetPublicDashboardInvitations-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Invitations data and metadata that exists for a shared dashboard returned by the API.
Expand All
Field
Type
Description
_required_]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
object
Object containing the information for an invitation to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
object
Pagination metadata returned by the API.
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
```
{
  "data": [
    {
      "attributes": {
        "email": "test@datadoghq.com"
      },
      "type": "public_dashboard_invitation"
    }
  ]
}
```

Copy
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Get all invitations for a shared dashboard
Copy
```
                  # Path parameters  
export token="CHANGE_ME"  
# Curl command  
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"  

                
```

#####  Get all invitations for a shared dashboard
```
"""
Get all invitations for a shared dashboard returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.get_public_dashboard_invitations(
        token=SHARED_DASHBOARD_TOKEN,
    )

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Get all invitations for a shared dashboard
```
# Get all invitations for a shared dashboard returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

# there is a valid "shared_dashboard" in the system
SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"]
p api_instance.get_public_dashboard_invitations(SHARED_DASHBOARD_TOKEN)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Get all invitations for a shared dashboard
```
// Get all invitations for a shared dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	// there is a valid "shared_dashboard" in the system
	SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN")

	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.GetPublicDashboardInvitations(ctx, SharedDashboardToken, *datadogV1.NewGetPublicDashboardInvitationsOptionalParameters())

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.GetPublicDashboardInvitations`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.GetPublicDashboardInvitations`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Get all invitations for a shared dashboard
```
// Get all invitations for a shared dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.SharedDashboardInvites;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    // there is a valid "shared_dashboard" in the system
    String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN");

    try {
      SharedDashboardInvites result =
          apiInstance.getPublicDashboardInvitations(SHARED_DASHBOARD_TOKEN);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#getPublicDashboardInvitations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Get all invitations for a shared dashboard
```
// Get all invitations for a shared dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::api_dashboards::GetPublicDashboardInvitationsOptionalParams;

#[tokio::main]
async fn main() {
    // there is a valid "shared_dashboard" in the system
    let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .get_public_dashboard_invitations(
            shared_dashboard_token.clone(),
            GetPublicDashboardInvitationsOptionalParams::default(),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Get all invitations for a shared dashboard
```
/**
 * Get all invitations for a shared dashboard returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

// there is a valid "shared_dashboard" in the system
const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string;

const params: v1.DashboardsApiGetPublicDashboardInvitationsRequest = {
  token: SHARED_DASHBOARD_TOKEN,
};

apiInstance
  .getPublicDashboardInvitations(params)
  .then((data: v1.SharedDashboardInvites) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Revoke a shared dashboard URL](https://docs.datadoghq.com/api/latest/dashboards/#revoke-a-shared-dashboard-url)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#revoke-a-shared-dashboard-url-v1)


DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}https://api.datadoghq.eu/api/v1/dashboard/public/{token}https://api.ddog-gov.com/api/v1/dashboard/public/{token}https://api.datadoghq.com/api/v1/dashboard/public/{token}https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}
### Overview
Revoke the public URL for a dashboard (rendering it private) associated with the specified token. This endpoint requires any of the following permissions:
* `dashboards_public_share`
* `dashboards_embed_share`
* `dashboards_invite_share`
  

OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
token [_required_]
string
The token of the shared dashboard.
### Response
  * [200](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboard-200-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboard-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboard-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboard-429-v1)


OK
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Response containing token of deleted shared dashboard.
Expand All
Field
Type
Description
deleted_public_dashboard_token
string
Token associated with the shared dashboard that was revoked.
```
{
  "deleted_public_dashboard_token": "string"
}
```

Copy
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Shared Dashboard Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Revoke a shared dashboard URL
Copy
```
                  # Path parameters  
export token="CHANGE_ME"  
# Curl command  
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"  

                
```

#####  Revoke a shared dashboard URL
```
"""
Revoke a shared dashboard URL returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    response = api_instance.delete_public_dashboard(
        token="token",
    )

    print(response)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Revoke a shared dashboard URL
```
# Revoke a shared dashboard URL returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
p api_instance.delete_public_dashboard("token")

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Revoke a shared dashboard URL
```
// Revoke a shared dashboard URL returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	resp, r, err := api.DeletePublicDashboard(ctx, "token")

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeletePublicDashboard`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.DeletePublicDashboard`:\n%s\n", responseContent)
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Revoke a shared dashboard URL
```
// Revoke a shared dashboard URL returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DeleteSharedDashboardResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    try {
      DeleteSharedDashboardResponse result = apiInstance.deletePublicDashboard("token");
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#deletePublicDashboard");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Revoke a shared dashboard URL
```
// Revoke a shared dashboard URL returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.delete_public_dashboard("token".to_string()).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Revoke a shared dashboard URL
```
/**
 * Revoke a shared dashboard URL returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

const params: v1.DashboardsApiDeletePublicDashboardRequest = {
  token: "token",
};

apiInstance
  .deletePublicDashboard(params)
  .then((data: v1.DeleteSharedDashboardResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
## [Revoke shared dashboard invitations](https://docs.datadoghq.com/api/latest/dashboards/#revoke-shared-dashboard-invitations)
  * [v1 (latest)](https://docs.datadoghq.com/api/latest/dashboards/#revoke-shared-dashboard-invitations-v1)


DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitationhttps://api.ddog-gov.com/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.us3.datadoghq.com/api/v1/dashboard/public/{token}/invitationhttps://api.us5.datadoghq.com/api/v1/dashboard/public/{token}/invitation
### Overview
Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses. This endpoint requires the `dashboards_invite_share` permission.
OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint.
### Arguments
#### Path Parameters
Name
Type
Description
token [_required_]
string
The token of the shared dashboard.
### Request
#### Body Data (required)
Shared Dashboard Invitation deletion request body.
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Expand All
Field
Type
Description
_required_]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
object
Object containing the information for an invitation to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
_required_]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
email
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [_required_]
enum
Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation`
object
Pagination metadata returned by the API.
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
```
{
  "data": [
    "undefined"
  ]
}
```

Copy
### Response
  * [204](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboardInvitation-204-v1)
  * [403](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboardInvitation-403-v1)
  * [404](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboardInvitation-404-v1)
  * [429](https://docs.datadoghq.com/api/latest/dashboards/#DeletePublicDashboardInvitation-429-v1)


OK
Forbidden
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Not Found
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
Too many requests
  * [Model](https://docs.datadoghq.com/api/latest/dashboards/)
  * [Example](https://docs.datadoghq.com/api/latest/dashboards/)


Error response object.
Expand All
Field
Type
Description
errors [_required_]
[string]
Array of errors returned by the API.
```
{
  "errors": [
    "Bad Request"
  ]
}
```

Copy
### Code Example
  * [Curl](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=curl)
  * [Python](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=python)
  * [Ruby](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=ruby)
  * [Go](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=go)
  * [Java](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=java)
  * [Rust](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=rust)
  * [Typescript](https://docs.datadoghq.com/api/latest/dashboards/?code-lang=typescript)


#####  Revoke shared dashboard invitations
Copy
```
                  ## json-request-body
# 
  
# Path parameters  
export token="CHANGE_ME"  
# Curl command  
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "email": "test@datadoghq.com"
    },
    "type": "public_dashboard_invitation"
  }
}
EOF  

                
```

#####  Revoke shared dashboard invitations
```
"""
Revoke shared dashboard invitations returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_invite_type import DashboardInviteType
from datadog_api_client.v1.model.shared_dashboard_invites import SharedDashboardInvites
from datadog_api_client.v1.model.shared_dashboard_invites_data_list import SharedDashboardInvitesDataList
from datadog_api_client.v1.model.shared_dashboard_invites_data_object import SharedDashboardInvitesDataObject
from datadog_api_client.v1.model.shared_dashboard_invites_data_object_attributes import (
    SharedDashboardInvitesDataObjectAttributes,
)

body = SharedDashboardInvites(
    data=SharedDashboardInvitesDataList(
        [
            SharedDashboardInvitesDataObject(
                attributes=SharedDashboardInvitesDataObjectAttributes(
                    email="test@datadoghq.com",
                ),
                type=DashboardInviteType.PUBLIC_DASHBOARD_INVITATION,
            ),
        ]
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = DashboardsApi(api_client)
    api_instance.delete_public_dashboard_invitation(token="token", body=body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"


```

#####  Revoke shared dashboard invitations
```
# Revoke shared dashboard invitations returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new

body = DatadogAPIClient::V1::SharedDashboardInvites.new({
  data: [
    DatadogAPIClient::V1::SharedDashboardInvitesDataObject.new({
      attributes: DatadogAPIClient::V1::SharedDashboardInvitesDataObjectAttributes.new({
        email: "test@datadoghq.com",
      }),
      type: DatadogAPIClient::V1::DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,
    }),
  ],
})
api_instance.delete_public_dashboard_invitation("token", body)

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"


```

#####  Revoke shared dashboard invitations
```
// Revoke shared dashboard invitations returns "OK" response

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)

func main() {
	body := datadogV1.SharedDashboardInvites{
		Data: datadogV1.SharedDashboardInvitesData{
			SharedDashboardInvitesDataList: &[]datadogV1.SharedDashboardInvitesDataObject{
				{
					Attributes: datadogV1.SharedDashboardInvitesDataObjectAttributes{
						Email: datadog.PtrString("test@datadoghq.com"),
					},
					Type: datadogV1.DASHBOARDINVITETYPE_PUBLIC_DASHBOARD_INVITATION,
				},
			}},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV1.NewDashboardsApi(apiClient)
	r, err := api.DeletePublicDashboardInvitation(ctx, "token", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeletePublicDashboardInvitation`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"


```

#####  Revoke shared dashboard invitations
```
// Revoke shared dashboard invitations returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardInviteType;
import com.datadog.api.client.v1.model.SharedDashboardInvites;
import com.datadog.api.client.v1.model.SharedDashboardInvitesData;
import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObject;
import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObjectAttributes;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    DashboardsApi apiInstance = new DashboardsApi(defaultClient);

    SharedDashboardInvites body =
        new SharedDashboardInvites()
            .data(
                new SharedDashboardInvitesData(
                    Collections.singletonList(
                        new SharedDashboardInvitesDataObject()
                            .attributes(
                                new SharedDashboardInvitesDataObjectAttributes()
                                    .email("test@datadoghq.com"))
                            .type(DashboardInviteType.PUBLIC_DASHBOARD_INVITATION))));

    try {
      apiInstance.deletePublicDashboardInvitation("token", body);
    } catch (ApiException e) {
      System.err.println("Exception when calling DashboardsApi#deletePublicDashboardInvitation");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"


```

#####  Revoke shared dashboard invitations
```
// Revoke shared dashboard invitations returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardInviteType;
use datadog_api_client::datadogV1::model::SharedDashboardInvites;
use datadog_api_client::datadogV1::model::SharedDashboardInvitesData;
use datadog_api_client::datadogV1::model::SharedDashboardInvitesDataObject;
use datadog_api_client::datadogV1::model::SharedDashboardInvitesDataObjectAttributes;

#[tokio::main]
async fn main() {
    let body =
        SharedDashboardInvites::new(SharedDashboardInvitesData::SharedDashboardInvitesDataList(
            vec![SharedDashboardInvitesDataObject::new(
                SharedDashboardInvitesDataObjectAttributes::new()
                    .email("test@datadoghq.com".to_string()),
                DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,
            )],
        ));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .delete_public_dashboard_invitation("token".to_string(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run


```

#####  Revoke shared dashboard invitations
```
/**
 * Revoke shared dashboard invitations returns "OK" response
 */

import { client, v1 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);

const params: v1.DashboardsApiDeletePublicDashboardInvitationRequest = {
  body: {
    data: [
      {
        attributes: {
          email: "test@datadoghq.com",
        },
        type: "public_dashboard_invitation",
      },
    ],
  },
  token: "token",
};

apiInstance
  .deletePublicDashboardInvitation(params)
  .then((data: any) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

```

Copy
#### Instructions
First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands:
```
    

DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"


```

* * *
![](https://id.rlcdn.com/464526.gif)
###### Request a personalized demo
×
*
First Name*
*
Last Name*
*
Business Email*
*
Company*
*
Job Title*
*
Phone Number
*
How are you currently monitoring your infrastructure and applications?
By submitting this form, you agree to the [Privacy Policy](https://www.datadoghq.com/legal/privacy/) and [Cookie Policy.](https://www.datadoghq.com/legal/cookies/)
Request a Demo
##### Get Started with Datadog
![](https://t.co/1/i/adsct?bci=4&dv=UTC%26en-US%26Google%20Inc.%26Linux%20x86_64%26255%261080%26600%264%2624%261080%26600%260%26na&eci=3&event=%7B%7D&event_id=bbcf7c9d-20d9-45a4-99a7-bf7cae564e8b&integration=gtm&p_id=Twitter&p_user_id=0&pl_id=2bc39a42-a97d-475f-bbad-66a9839889b0&pt=Dashboards&tw_document_href=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&tw_iframe_status=0&txn_id=nui23&type=javascript&version=2.3.35)![](https://analytics.twitter.com/1/i/adsct?bci=4&dv=UTC%26en-US%26Google%20Inc.%26Linux%20x86_64%26255%261080%26600%264%2624%261080%26600%260%26na&eci=3&event=%7B%7D&event_id=bbcf7c9d-20d9-45a4-99a7-bf7cae564e8b&integration=gtm&p_id=Twitter&p_user_id=0&pl_id=2bc39a42-a97d-475f-bbad-66a9839889b0&pt=Dashboards&tw_document_href=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&tw_iframe_status=0&txn_id=nui23&type=javascript&version=2.3.35)
![](https://bat.bing.com/action/0?ti=4061438&Ver=2&mid=8f213669-2502-468a-ac02-134da355f6b8&bo=2&sid=e9375cd0f0bd11f08bcff787fa0fba6f&vid=e9375d80f0bd11f0b5075ff6ae9d9677&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1080&sh=600&sc=24&tl=Dashboards&p=https%3A%2F%2Fdocs.datadoghq.com%2Fapi%2Flatest%2Fdashboards%2F&r=&lt=87738&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=33056)
Feedback
## Was this page helpful?
Yes 🎉
No 👎
Next
![](https://survey-images.hotjar.com/surveys/logo/90f40352a7464c849f5ce82ccd0e758d)