The groups widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible. Use groups to organize the widgets on your dashboard.
Setup
Add several widgets to your dashboard.
Select multiple widgets with the click and drag feature, or press Shift and click.
Click on the Group option.
Click the pencil icon in the upper right corner of your group to choose a name and apply a style to your group.
Background color of the widget. Supported values are white, blue, purple, pink, orange, yellow, green, gray, vivid_blue, vivid_purple, vivid_pink, vivid_orange, vivid_yellow, vivid_green, and transparent.
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
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.
description
string
The description of 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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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.
description
string
The description of 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 bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups.
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.
description
string
The description of the widget.
requests [required]
[object]
List of bar chart widget requests.
apm_query
object
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metric
string
Measurable attribute to compute.
name
string
Name of the compute for use in formulas.
rollup
object
Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
data_source [required]
enum
Data source for Product Analytics Extended queries.
Allowed enum values: product_analytics_extended
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
end
string
End value.
start
string
Start value.
type [required]
string
Target type.
value
string
Target value.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval [required]
object
Time interval for cohort criteria.
type [required]
enum
Type of time interval for cohort criteria.
Allowed enum values: calendar
value [required]
object
Calendar interval definition.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
accounts
[object]
name
string
The name of the account subquery.
query
string
The query string for the account subquery.
filter_condition
string
An optional filter condition applied to the audience subquery.
segments
[object]
name
string
The name of the segment subquery.
segment_id
string
The unique identifier of the segment.
users
[object]
name
string
The name of the user subquery.
query
string
The query string for the user subquery.
string_filter
string
String filter.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval
object
Time interval for return criteria.
type [required]
enum
Type of time interval for return criteria.
Allowed enum values: fixed
unit [required]
enum
Unit of time for retention return criteria interval.
Allowed enum values: day,week,month
value [required]
double
Value of the time interval.
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
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
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
order_by
enum
How to order series in timeseries visualizations.
tags: Order series alphabetically by tag name (default behavior)
values: Order series by their current metric values (typically descending)
Allowed enum values: tags,values
palette
string
Color palette to apply to the widget.
style
object
Style customization for a bar chart widget.
display
<oneOf>
Bar chart widget display options.
Option 1
object
Bar chart widget stacked display options.
legend
enum
Bar chart widget stacked legend behavior.
Allowed enum values: automatic,inline,none
type [required]
enum
Bar chart widget stacked display type.
Allowed enum values: stacked
default: stacked
Option 2
object
Bar chart widget flat display.
type [required]
enum
Bar chart widget flat display type.
Allowed enum values: flat
default: flat
palette
string
Color palette to apply to the widget.
scaling
enum
Bar chart 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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 bar chart widget.
Allowed enum values: bar_chart
default: bar_chart
Option 4
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.
description
string
The description of the widget.
requests [required]
[object]
Array of one request object to display in the widget.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metric
string
Measurable attribute to compute.
name
string
Name of the compute for use in formulas.
rollup
object
Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
data_source [required]
enum
Data source for Product Analytics Extended queries.
Allowed enum values: product_analytics_extended
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
end
string
End value.
start
string
Start value.
type [required]
string
Target type.
value
string
Target value.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval [required]
object
Time interval for cohort criteria.
type [required]
enum
Type of time interval for cohort criteria.
Allowed enum values: calendar
value [required]
object
Calendar interval definition.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
accounts
[object]
name
string
The name of the account subquery.
query
string
The query string for the account subquery.
filter_condition
string
An optional filter condition applied to the audience subquery.
segments
[object]
name
string
The name of the segment subquery.
segment_id
string
The unique identifier of the segment.
users
[object]
name
string
The name of the user subquery.
query
string
The query string for the user subquery.
string_filter
string
String filter.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval
object
Time interval for return criteria.
type [required]
enum
Type of time interval for return criteria.
Allowed enum values: fixed
unit [required]
enum
Unit of time for retention return criteria interval.
Allowed enum values: day,week,month
value [required]
double
Value of the time interval.
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
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 5
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.
description
string
The description of 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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 6
object
The cohort widget visualizes user retention over time.
description
string
The description of the widget.
requests [required]
[object]
List of Cohort widget requests.
query [required]
object
Retention query definition.
compute [required]
object
Compute configuration for retention queries.
aggregation [required]
<oneOf>
The type of aggregation that can be performed on events-based queries.
Option 1
enum
Standard aggregation types for events-based queries.
Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequentShow 1 more,sum
Option 2
string
Percentile aggregation.
metric [required]
enum
Metric for retention compute.
Allowed enum values: __dd.retention,__dd.retention_rate
data_source [required]
enum
Data source for retention queries.
Allowed enum values: product_analytics_retention
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
accounts
[object]
name
string
The name of the account subquery.
query
string
The query string for the account subquery.
filter_condition
string
An optional filter condition applied to the audience subquery.
Target for retention group by.
Allowed enum values: cohort,return_period
name
string
Name of the query.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval [required]
object
Time interval for cohort criteria.
type [required]
enum
Type of time interval for cohort criteria.
Allowed enum values: calendar
value [required]
object
Calendar interval definition.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
accounts
[object]
name
string
The name of the account subquery.
query
string
The query string for the account subquery.
filter_condition
string
An optional filter condition applied to the audience subquery.
segments
[object]
name
string
The name of the segment subquery.
segment_id
string
The unique identifier of the segment.
users
[object]
name
string
The name of the user subquery.
query
string
The query string for the user subquery.
string_filter
string
String filter.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval
object
Time interval for return criteria.
type [required]
enum
Type of time interval for return criteria.
Allowed enum values: fixed
unit [required]
enum
Unit of time for retention return criteria interval.
Allowed enum values: day,week,month
value [required]
double
Value of the time interval.
request_type [required]
enum
Request type for retention grid widget.
Allowed enum values: retention_grid
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 Cohort widget.
Allowed enum values: cohort
default: cohort
Option 7
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.
description
string
The description of the widget.
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.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metric
string
Measurable attribute to compute.
name
string
Name of the compute for use in formulas.
rollup
object
Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
data_source [required]
enum
Data source for Product Analytics Extended queries.
Allowed enum values: product_analytics_extended
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
end
string
End value.
start
string
Start value.
type [required]
string
Target type.
value
string
Target value.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval [required]
object
Time interval for cohort criteria.
type [required]
enum
Type of time interval for cohort criteria.
Allowed enum values: calendar
value [required]
object
Calendar interval definition.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
accounts
[object]
name
string
The name of the account subquery.
query
string
The query string for the account subquery.
filter_condition
string
An optional filter condition applied to the audience subquery.
segments
[object]
name
string
The name of the segment subquery.
segment_id
string
The unique identifier of the segment.
users
[object]
name
string
The name of the user subquery.
query
string
The query string for the user subquery.
string_filter
string
String filter.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval
object
Time interval for return criteria.
type [required]
enum
Type of time interval for return criteria.
Allowed enum values: fixed
unit [required]
enum
Unit of time for retention return criteria interval.
Allowed enum values: day,week,month
value [required]
double
Value of the time interval.
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
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
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_p95Show 1 more,latency_p99
Option 4
object
A formula and functions APM metrics query.
data_source [required]
enum
Data source for APM metrics queries.
Allowed enum values: apm_metrics
group_by
[string]
Optional fields to group the query results by.
name [required]
string
Name of this query to use in formulas.
operation_mode
string
Optional operation mode to aggregate across operation names.
operation_name
string
Name of operation on service. If not provided, the primary operation name is used.
peer_tags
[string]
Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filter
string
Additional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hash
string
The hash of a specific resource to filter by.
resource_name
string
The full name of a specific resource to filter by.
service
string
APM service name.
span_kind
enum
Describes the relationship between the span, its parents, and its children in a trace.
Allowed enum values: consumer,server,client,producer,internal
stat [required]
enum
APM metric stat name.
Allowed enum values: errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex
request_type
enum
Distribution of point values for distribution metrics. Renders a histogram of raw metric data points.
Allowed enum values: histogram
response_format
enum
Distribution of aggregated grouped queries. Use request_type instead for distribution of point values from distribution metrics.
Allowed enum values: timeseries,scalar,event_list
rum_query
object
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 8
object
The event stream is a widget version of the stream of events
on the Event Stream view. Only available on FREE layout dashboards.
description
string
The description of the widget.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 9
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.
description
string
The description of the widget.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 10
object
Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
background_color
string
Background color of the widget. Supported values are white, blue, purple, pink, orange, yellow, green, gray, vivid_blue, vivid_purple, vivid_pink, vivid_orange, vivid_yellow, vivid_green, and transparent.
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 11
object
The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
description
string
The description of the widget.
grouped_display
enum
Display mode for grouped funnel results.
Allowed enum values: stacked,side_by_side
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 12
object
The user journey funnel visualization displays conversion funnels based on user journey data from Product Analytics.
description
string
The description of the widget.
grouped_display
enum
Display mode for grouped funnel results.
Allowed enum values: stacked,side_by_side
requests [required]
[object]
Request payload used to query items.
comparison_segments
[string]
Comparison segments.
comparison_time
object
Comparison time configuration for funnel widgets.
custom_timeframe
object
Custom timeframe for funnel comparison.
from [required]
double
Start of the custom timeframe.
to [required]
double
End of the custom timeframe.
type [required]
enum
Type of comparison duration.
Allowed enum values: previous_timeframe,custom_timeframe,previous_day,previous_week,previous_month
query [required]
object
User journey funnel query definition.
compute
object
Compute configuration for user journey funnel.
aggregation [required]
enum
Aggregation type for user journey funnel compute.
Allowed enum values: cardinality,count
metric [required]
enum
Metric for user journey funnel compute. __dd.conversion and __dd.conversion_rate accept count (unique users/sessions) and cardinality (total users/sessions) as aggregations.
Allowed enum values: __dd.conversion,__dd.conversion_rate
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet to group by.
limit
int64
Maximum number of groups.
should_exclude_missing
boolean
Whether to exclude missing values.
sort
object
Sort configuration for user journey funnel group by.
An optional filter condition applied to the audience subquery.
segments
[object]
name
string
The name of the segment subquery.
segment_id
string
The unique identifier of the segment.
users
[object]
name
string
The name of the user subquery.
query
string
The query string for the user subquery.
graph_filters
[object]
Graph filters.
name
string
Filter name.
operator
string
Filter operator.
target
object
Target for user journey search.
end
string
End value.
start
string
Start value.
type [required]
string
Target type.
value
string
Target value.
value
int64
Filter value.
string_filter
string
String filter.
join_keys
object
Join keys for user journey queries.
primary [required]
string
Primary join key.
secondary
[string]
Secondary join keys.
node_objects [required]
object
Node objects mapping.
<any-key>
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
step_aliases
object
Step aliases mapping.
<any-key>
string
subquery_id
string
Subquery ID.
request_type [required]
enum
Request type for user journey funnel widget.
Allowed enum values: user_journey_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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 13
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.
description
string
The description of the widget.
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
for information about building the REQUEST_SCHEMA.
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_whiteShow 9 more,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_whiteShow 9 more,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
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metric
string
Measurable attribute to compute.
name
string
Name of the compute for use in formulas.
rollup
object
Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
data_source [required]
enum
Data source for Product Analytics Extended queries.
Allowed enum values: product_analytics_extended
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
end
string
End value.
start
string
Start value.
type [required]
string
Target type.
value
string
Target value.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval [required]
object
Time interval for cohort criteria.
type [required]
enum
Type of time interval for cohort criteria.
Allowed enum values: calendar
value [required]
object
Calendar interval definition.
alignment
string
Alignment of the interval. Valid values depend on the interval type. For day, use hours (for example, 1am, 2pm, or 14). For week, use day names (for example, monday). For month, use day-of-month ordinals (for example, 1st, 15th). For year or quarter, use month names (for example, january).
quantity
int64
Quantity of the interval.
timezone
string
Timezone for the interval.
type [required]
enum
Type of calendar interval.
Allowed enum values: day,week,month,year,quarter,minute,hour
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
accounts
[object]
name
string
The name of the account subquery.
query
string
The query string for the account subquery.
filter_condition
string
An optional filter condition applied to the audience subquery.
segments
[object]
name
string
The name of the segment subquery.
segment_id
string
The unique identifier of the segment.
users
[object]
name
string
The name of the user subquery.
query
string
The query string for the user subquery.
string_filter
string
String filter.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
data_source [required]
enum
Data source for Product Analytics event queries.
Allowed enum values: product_analytics
search [required]
object
Search configuration for Product Analytics event query.
query [required]
string
RUM event search query used to filter views or actions.
time_interval
object
Time interval for return criteria.
type [required]
enum
Type of time interval for return criteria.
Allowed enum values: fixed
unit [required]
enum
Unit of time for retention return criteria interval.
Allowed enum values: day,week,month
value [required]
double
Value of the time interval.
query
object
Updated list stream widget.
assignee_uuids
[string]
Filter by assignee UUIDs. Usable only with issue_stream.
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.
Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead.
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_streamShow 4 more,event_stream,rum_stream,llm_observability_stream,issue_stream
default: logs_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.
persona
enum
Persona filter for the issue_stream data source.
Allowed enum values: all,browser,mobile,backend
Filter by issue states. Usable only with issue_stream.
storage
string
Option for storage location. Feature in Private Beta.
suspected_causes
[string]
Filter by suspected causes. Usable only with issue_stream.
team_handles
[string]
Filter by team handles. Usable only with issue_stream.
version
enum
Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is
preserved. Set to sequential_query to use v2 behavior. This feature is in Preview.
Allowed enum values: sequential_query
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
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 14
object
The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
background_color
string
Background color of the widget. Supported values are white, blue, purple, pink, orange, yellow, green, gray, vivid_blue, vivid_purple, vivid_pink, vivid_orange, vivid_yellow, vivid_green, and transparent.
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
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.
description
string
The description of 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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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.
description
string
The description of 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 bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups.
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.
description
string
The description of the widget.
requests [required]
[object]
List of bar chart widget requests.
apm_query
object
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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.
Option 2
object
Custom unit.
unit_scale
object
The definition of NumberFormatUnitScale object.
type
enum
The type of unit scale.
Allowed enum values: canonical_unit
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Option 1
[object]
List of objects used to group by.
Option 2
object
Flat group by configuration using multiple event facet fields.
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.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
sort
object
Options for sorting group by results.
target
object
Target for user journey search.
name [required]
string
Name of the query for use in formulas.
search [required]
object
User journey search configuration.
expression [required]
string
Expression string.
filters
object
Filters for user journey search.
join_keys
object
Join keys for user journey queries.
node_objects [required]
object
Node objects mapping.
step_aliases
object
Step aliases mapping.
Option 11
object
A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]
object
Compute configuration for retention queries.
aggregation [required]
<oneOf>
The type of aggregation that can be performed on events-based queries.
metric [required]
enum
Metric for retention compute.
Allowed enum values: __dd.retention,__dd.retention_rate
data_source [required]
enum
Data source for retention queries.
Allowed enum values: product_analytics_retention
group_by
[object]
Group by configuration.
facet [required]
string
Facet to group by.
limit
int64
Maximum number of groups.
should_exclude_missing
boolean
Whether to exclude missing values.
sort
object
Sort configuration for retention group by.
source
string
Source field.
target [required]
enum
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
filters
object
Filters for retention queries.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
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
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
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
order_by
enum
How to order series in timeseries visualizations.
tags: Order series alphabetically by tag name (default behavior)
values: Order series by their current metric values (typically descending)
Allowed enum values: tags,values
palette
string
Color palette to apply to the widget.
style
object
Style customization for a bar chart widget.
display
<oneOf>
Bar chart widget display options.
Option 1
object
Bar chart widget stacked display options.
legend
enum
Bar chart widget stacked legend behavior.
Allowed enum values: automatic,inline,none
type [required]
enum
Bar chart widget stacked display type.
Allowed enum values: stacked
default: stacked
Option 2
object
Bar chart widget flat display.
type [required]
enum
Bar chart widget flat display type.
Allowed enum values: flat
default: flat
palette
string
Color palette to apply to the widget.
scaling
enum
Bar chart 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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 bar chart widget.
Allowed enum values: bar_chart
default: bar_chart
Option 4
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.
description
string
The description of the widget.
requests [required]
[object]
Array of one request object to display in the widget.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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.
Option 2
object
Custom unit.
unit_scale
object
The definition of NumberFormatUnitScale object.
type
enum
The type of unit scale.
Allowed enum values: canonical_unit
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Option 1
[object]
List of objects used to group by.
Option 2
object
Flat group by configuration using multiple event facet fields.
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.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
sort
object
Options for sorting group by results.
target
object
Target for user journey search.
name [required]
string
Name of the query for use in formulas.
search [required]
object
User journey search configuration.
expression [required]
string
Expression string.
filters
object
Filters for user journey search.
join_keys
object
Join keys for user journey queries.
node_objects [required]
object
Node objects mapping.
step_aliases
object
Step aliases mapping.
Option 11
object
A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]
object
Compute configuration for retention queries.
aggregation [required]
<oneOf>
The type of aggregation that can be performed on events-based queries.
metric [required]
enum
Metric for retention compute.
Allowed enum values: __dd.retention,__dd.retention_rate
data_source [required]
enum
Data source for retention queries.
Allowed enum values: product_analytics_retention
group_by
[object]
Group by configuration.
facet [required]
string
Facet to group by.
limit
int64
Maximum number of groups.
should_exclude_missing
boolean
Whether to exclude missing values.
sort
object
Sort configuration for retention group by.
source
string
Source field.
target [required]
enum
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
filters
object
Filters for retention queries.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
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
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 5
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.
description
string
The description of 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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 6
object
The cohort widget visualizes user retention over time.
description
string
The description of the widget.
requests [required]
[object]
List of Cohort widget requests.
query [required]
object
Retention query definition.
compute [required]
object
Compute configuration for retention queries.
aggregation [required]
<oneOf>
The type of aggregation that can be performed on events-based queries.
Option 1
enum
Standard aggregation types for events-based queries.
Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequentShow 1 more,sum
Option 2
string
Percentile aggregation.
metric [required]
enum
Metric for retention compute.
Allowed enum values: __dd.retention,__dd.retention_rate
data_source [required]
enum
Data source for retention queries.
Allowed enum values: product_analytics_retention
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
accounts
[object]
filter_condition
string
An optional filter condition applied to the audience subquery.
Target for retention group by.
Allowed enum values: cohort,return_period
name
string
Name of the query.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
time_interval [required]
object
Time interval for cohort criteria.
filters
object
Filters for retention queries.
audience_filters
object
Product Analytics/RUM audience filters.
string_filter
string
String filter.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
base_query [required]
object
Base query for Product Analytics.
time_interval
object
Time interval for return criteria.
request_type [required]
enum
Request type for retention grid widget.
Allowed enum values: retention_grid
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 Cohort widget.
Allowed enum values: cohort
default: cohort
Option 7
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.
description
string
The description of the widget.
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.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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_whiteShow 9 more,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.
Option 2
object
Custom unit.
unit_scale
object
The definition of NumberFormatUnitScale object.
type
enum
The type of unit scale.
Allowed enum values: canonical_unit
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Option 1
[object]
List of objects used to group by.
Option 2
object
Flat group by configuration using multiple event facet fields.
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.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
sort
object
Options for sorting group by results.
target
object
Target for user journey search.
name [required]
string
Name of the query for use in formulas.
search [required]
object
User journey search configuration.
expression [required]
string
Expression string.
filters
object
Filters for user journey search.
join_keys
object
Join keys for user journey queries.
node_objects [required]
object
Node objects mapping.
step_aliases
object
Step aliases mapping.
Option 11
object
A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]
object
Compute configuration for retention queries.
aggregation [required]
<oneOf>
The type of aggregation that can be performed on events-based queries.
metric [required]
enum
Metric for retention compute.
Allowed enum values: __dd.retention,__dd.retention_rate
data_source [required]
enum
Data source for retention queries.
Allowed enum values: product_analytics_retention
group_by
[object]
Group by configuration.
facet [required]
string
Facet to group by.
limit
int64
Maximum number of groups.
should_exclude_missing
boolean
Whether to exclude missing values.
sort
object
Sort configuration for retention group by.
source
string
Source field.
target [required]
enum
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
filters
object
Filters for retention queries.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
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
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Option 1
[object]
List of objects used to group by.
Option 2
object
Flat group by configuration using multiple event facet fields.
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
DEPRECATED: APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
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
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_p95Show 1 more,latency_p99
Option 4
object
A formula and functions APM metrics query.
data_source [required]
enum
Data source for APM metrics queries.
Allowed enum values: apm_metrics
group_by
[string]
Optional fields to group the query results by.
name [required]
string
Name of this query to use in formulas.
operation_mode
string
Optional operation mode to aggregate across operation names.
operation_name
string
Name of operation on service. If not provided, the primary operation name is used.
peer_tags
[string]
Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filter
string
Additional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hash
string
The hash of a specific resource to filter by.
resource_name
string
The full name of a specific resource to filter by.
service
string
APM service name.
span_kind
enum
Describes the relationship between the span, its parents, and its children in a trace.
Allowed enum values: consumer,server,client,producer,internal
stat [required]
enum
APM metric stat name.
Allowed enum values: errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex
request_type
enum
Distribution of point values for distribution metrics. Renders a histogram of raw metric data points.
Allowed enum values: histogram
response_format
enum
Distribution of aggregated grouped queries. Use request_type instead for distribution of point values from distribution metrics.
Allowed enum values: timeseries,scalar,event_list
rum_query
object
DEPRECATED: Deprecated - Use queries and formulas instead.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 8
object
The event stream is a widget version of the stream of events
on the Event Stream view. Only available on FREE layout dashboards.
description
string
The description of the widget.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 9
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.
description
string
The description of the widget.
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 10
object
Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
background_color
string
Background color of the widget. Supported values are white, blue, purple, pink, orange, yellow, green, gray, vivid_blue, vivid_purple, vivid_pink, vivid_orange, vivid_yellow, vivid_green, and transparent.
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 11
object
The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
description
string
The description of the widget.
grouped_display
enum
Display mode for grouped funnel results.
Allowed enum values: stacked,side_by_side
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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 12
object
The user journey funnel visualization displays conversion funnels based on user journey data from Product Analytics.
description
string
The description of the widget.
grouped_display
enum
Display mode for grouped funnel results.
Allowed enum values: stacked,side_by_side
requests [required]
[object]
Request payload used to query items.
comparison_segments
[string]
Comparison segments.
comparison_time
object
Comparison time configuration for funnel widgets.
custom_timeframe
object
Custom timeframe for funnel comparison.
from [required]
double
Start of the custom timeframe.
to [required]
double
End of the custom timeframe.
type [required]
enum
Type of comparison duration.
Allowed enum values: previous_timeframe,custom_timeframe,previous_day,previous_week,previous_month
query [required]
object
User journey funnel query definition.
compute
object
Compute configuration for user journey funnel.
aggregation [required]
enum
Aggregation type for user journey funnel compute.
Allowed enum values: cardinality,count
metric [required]
enum
Metric for user journey funnel compute. __dd.conversion and __dd.conversion_rate accept count (unique users/sessions) and cardinality (total users/sessions) as aggregations.
Allowed enum values: __dd.conversion,__dd.conversion_rate
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet to group by.
limit
int64
Maximum number of groups.
should_exclude_missing
boolean
Whether to exclude missing values.
sort
object
Sort configuration for user journey funnel group by.
Request type for user journey funnel widget.
Allowed enum values: user_journey_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,1wShow 7 more,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 milliseconds since epoch.
hide_incomplete_cost_data
boolean
Whether to hide incomplete cost data in the widget.
to [required]
int64
End time in milliseconds 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 13
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.
description
string
The description of the widget.
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
for information about building the REQUEST_SCHEMA.
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_whiteShow 9 more,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_whiteShow 9 more,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.
Option 2
object
Custom unit.
unit_scale
object
The definition of NumberFormatUnitScale object.
type
enum
The type of unit scale.
Allowed enum values: canonical_unit
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_pipelinesShow 5 more,incident_analytics,product_analytics,on_call_events,errors,llm_observability
group_by
<oneOf>
Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
Option 1
[object]
List of objects used to group by.
Option 2
object
Flat group by configuration using multiple event facet fields.
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.
Time bucket interval in milliseconds for time series queries.
metric
enum
Metric for User Journey formula compute. __dd.conversion and __dd.conversion_rate accept count and cardinality as aggregations. __dd.time_to_convert accepts avg, median, pc75, pc95, pc98, pc99, min, and max.
Allowed enum values: __dd.conversion,__dd.conversion_rate,__dd.time_to_convert
target
object
Target for user journey search.
data_source [required]
enum
Data source for user journey funnel queries.
Allowed enum values: product_analytics_journey
group_by
[object]
Group by configuration.
facet [required]
string
Facet name to group by.
limit
int32
Maximum number of groups to return.
should_exclude_missing
boolean
Whether to exclude events missing the group-by facet.
sort
object
Options for sorting group by results.
target
object
Target for user journey search.
name [required]
string
Name of the query for use in formulas.
search [required]
object
User journey search configuration.
expression [required]
string
Expression string.
filters
object
Filters for user journey search.
join_keys
object
Join keys for user journey queries.
node_objects [required]
object
Node objects mapping.
step_aliases
object
Step aliases mapping.
Option 11
object
A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]
object
Compute configuration for retention queries.
aggregation [required]
<oneOf>
The type of aggregation that can be performed on events-based queries.
metric [required]
enum
Metric for retention compute.
Allowed enum values: __dd.retention,__dd.retention_rate
data_source [required]
enum
Data source for retention queries.
Allowed enum values: product_analytics_retention
group_by
[object]
Group by configuration.
facet [required]
string
Facet to group by.
limit
int64
Maximum number of groups.
should_exclude_missing
boolean
Whether to exclude missing values.
sort
object
Sort configuration for retention group by.
source
string
Source field.
target [required]
enum
Target for retention group by.
Allowed enum values: cohort,return_period
name [required]
string
Name of the query for use in formulas.
search [required]
object
Search configuration for retention queries.
cohort_criteria [required]
object
Cohort criteria for retention queries.
filters
object
Filters for retention queries.
retention_entity [required]
enum
Entity to track for retention.
Allowed enum values: @usr.id,@account.id
return_condition [required]
enum
Condition for counting user return.
Allowed enum values: conversion_on,conversion_on_or_after
return_criteria
object
Return criteria for retention queries.
query
object
Updated list stream widget.
assignee_uuids
[string]
Filter by assignee UUIDs. Usable only with issue_stream.
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.
Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead.
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_streamShow 4 more,event_stream,rum_stream,llm_observability_stream,issue_stream
default: logs_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.
