Language

日本語 English Français 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED

Get a dashboard

copy Copy pageCopied

GET https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.us2.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.uk1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id}

概要

指定の ID を使用してダッシュボードを取得します。 This endpoint requires the dashboards_read permission.

OAuth apps require the dashboards_read authorization scope to access this endpoint.

引数

パスパラメーター

名前

種類

説明

dashboard_id [required]

string

The ID of the dashboard.

応答

OK

A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

Expand All

フィールド

種類

説明

author_handle

string

Identifier of the dashboard author.

author_name

string

Name of the dashboard author.

created_at

date-time

Creation date of the dashboard.

default_timeframe

 <oneOf>

The default timeframe applied when opening the dashboard. Set to null to clear.

Option 1

object

A live dashboard timeframe.

type [required]

enum

Type of live timeframe. 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 live timeframe span.

Option 2

object

A fixed dashboard timeframe.

from [required]

int64

Start time in milliseconds since epoch.

to [required]

int64

End time in milliseconds since epoch.

type [required]

enum

Type of fixed timeframe. Allowed enum values: fixed

description

string

Description of the dashboard.

id

string

ID of the dashboard.

is_read_only

boolean

DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it.

This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.

layout_type [required]

enum

Layout type of the dashboard. Allowed enum values: ordered,free

modified_at

date-time

Modification date of the dashboard.

notify_list

[string]

List of handles of users to notify when changes are made to this dashboard.

reflow_type

enum

Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Allowed enum values: auto,fixed

restricted_roles

[string]

A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.

tabs

[object]

List of tabs for organizing dashboard widgets into groups.

id [required]

uuid

UUID of the tab.

name [required]

string

Name of the tab.

widget_ids [required]

[integer]

List of widget IDs belonging to this tab. The backend also accepts positional references in @N format (1-indexed) as a convenience for Terraform and other declarative tools.

tags

[string]

List of team names representing ownership of a dashboard.

template_variable_presets

[object]

Array of template variables saved views.

name

string

The name of the variable.

template_variables

[object]

List of variables.

name

string

The name of the variable.

value

string

DEPRECATED: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values.

values

[string]

One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value.

template_variables

[object]

List of template variables for this dashboard.

available_values

[string]

The list of values that the template variable drop-down is limited to.

default

string

DEPRECATED: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.

defaults

[string]

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

name [required]

string

The name of the variable.

prefix

string

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

type

string

The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).

title [required]

string

Title of the dashboard.

url

string

The URL of the dashboard.

widgets [required]

[object]

List of widgets to display on the dashboard.

definition [required]

 <oneOf>

Definition of the widget.

Option 1

object

Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.

alert_id [required]

string

ID of the alert to use in the widget.

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,1w

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Define request widget style.

line_type

enum

Type of lines displayed. Allowed enum values: dashed,dotted,solid

line_width

enum

Width of line displayed. Allowed enum values: normal,thick,thin

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,1w

Show 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.

See the dedicated Request JSON schema documentation to learn how to build the REQUEST_SCHEMA.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

change_type

enum

Show the absolute or the relative change. Allowed enum values: absolute,relative

compare_to

enum

Timeframe used for the change comparison. Allowed enum values: hour_before,day_before,week_before,month_before

event_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

increase_good

boolean

Whether to show increase as good.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

order_by

enum

What to order by. Allowed enum values: change,name,present,past

order_dir

enum

Widget sorting methods. Allowed enum values: asc,desc

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Query definition. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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,1w

Show 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,1w

Show 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_frequent

Show 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.

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.

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

source

string

Source field.

target [required]

enum

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,1w

Show 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.

See the dedicated Request JSON schema documentation to learn how to build the REQUEST_SCHEMA.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

apm_stats_query

object

The APM stats query for table and distributions widgets.

columns

[object]

Column properties used by the front end for display.

alias

string

A user-assigned alias for the column.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

name [required]

string

Column name.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

env [required]

string

Environment name.

name [required]

string

Operation name associated with service.

primary_tag [required]

string

The organization's host group name and value.

resource

string

Resource name.

row_type [required]

enum

The level of detail for the request. Allowed enum values: service,resource,span

service [required]

string

Service name.

event_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 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_p99

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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,1w

Show 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,1w

Show 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,1w

Show 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,1w

Show 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.

aggregation [required]

string

Aggregation type.

metric

string

Metric to sort by.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

search [required]

object

User journey search configuration.

expression [required]

string

Expression string.

filters

object

Filters for user journey search.

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.

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,1w

Show 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.

columns

[object]

Widget columns.

field [required]

string

Widget column field.

width [required]

enum

Widget column width. Allowed enum values: auto,compact,full

conditional_formats

[object]

Threshold (numeric) conditional formatting rules may be used by a regions layer.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: The widget metrics query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

aggregation [required]

enum

Aggregation value. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 5 more,max,avg,earliest,latest,most_frequent

facet

string

Facet name.

data_source [required]

enum

Source from which to query items to display in the stream. 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_stream

Show 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

query_string [required]

string

Widget query.

sort

object

Which column and order to sort by

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

states

[string]

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

The style to apply to the request for points layer.

color_by

string

The category to color the points by.

text_formats

[object]

Text formatting rules may be used by a points layer.

custom_bg_color

string

Hex representation of the custom background color. Used with custom background palette option.

custom_fg_color

string

Hex representation of the custom text color. Used with custom text palette option.

match [required]

object

Match rule for the table widget text format.

type [required]

enum

Match or compare option. Allowed enum values: is,is_not,contains,does_not_contain,starts_with,ends_with

value [required]

string

Table Widget Match String.

palette

enum

Color-on-color palette to highlight replaced text. Allowed enum values: white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg

Show 1 more,custom_text

default: white_on_green

replace

 <oneOf>

Replace rule for the table widget text format.

Option 1

object

Match All definition.

type [required]

enum

Table widget text format replace all type. Allowed enum values: all

with [required]

string

Replace All type.

Option 2

object

Match Sub-string definition.

substring [required]

string

Text that will be replaced.

type [required]

enum

Table widget text format replace sub-string type. Allowed enum values: substring

with [required]

string

Text that will replace original sub-string.

style [required]

object

The style to apply to the widget.

palette [required]

string

The color palette to apply to the widget.

palette_flip [required]

boolean

Whether to flip the palette tones.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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

default: group

widgets [required]

[object]

List of widget groups.

Option 15

object

The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

events

[object]

DEPRECATED: List of widget events. Deprecated - Use overlay request type instead.

q [required]

string

Query definition.

tags_execution

string

The execution method for multi-value filters.

legend_size

string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

markers

[object]

List of markers.

display_type

string

Combination of:

  • A severity error, warning, ok, or info
  • A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be percentile.

label

string

Label to display over the marker.

time

string

Timestamp for the widget.

value [required]

string

Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with display_type set to percentile, this should be a numeric percentile value (for example, "90" for P90).

requests [required]

[object]

List of widget types.

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

event_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

search [required]

string

The query being made on the event.

tags_execution [required]

string

The execution method for multi-value filters. Can be either and or or.

formulas

[object]

List of formulas that operate on queries.

alias

string

Expression alias.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

cell_display_mode_options

object

Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).

trend_type

enum

Trend type for the cell display mode options. Allowed enum values: area,line,bars

y_scale

enum

Y scale for the cell display mode options. Allowed enum values: shared,independent

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

request_type

enum

Applicable only for distribution of point values for distribution metrics. Allowed enum values: histogram

response_format

enum

Applicable only for distribution of aggregated grouped queries. 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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

Whether or not to display the legend on this widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 heat map widget. Allowed enum values: heatmap

default: heatmap

xaxis

object

X Axis controls for the heat map widget.

num_buckets

int64

Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier).

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

Option 16

object

The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

group

[string]

DEPRECATED: Deprecated - Only used by the legacy metric-based format. Use group_by (infrastructure) or a group dimension (DDSQL) inside requests instead.

no_group_hosts

boolean

DEPRECATED: Deprecated - Only used by the legacy metric-based format. Use no_group_hosts inside requests instead.

no_metric_hosts

boolean

DEPRECATED: Deprecated - Only used by the legacy metric-based format. Use no_metric_hosts inside requests instead.

node_type

enum

DEPRECATED: Deprecated - Only used by the legacy metric-based format. Use node_type inside requests instead. Allowed enum values: host,container

notes

string

Notes on the title.

requests [required]

object

Query definition for the host map widget. Supports three mutually exclusive formats distinguished by request_type: the deprecated legacy metric-based format (fill/size, no request_type), the infrastructure-backed format (request_type: infrastructure_hostmap), and the DDSQL published-dataset format (request_type: data_projection).

child

object

Optional child entities for hierarchical visualization (for example, host → container). Only used by the infrastructure-backed format.

child

object

Optional child request for hierarchical visualization (for example, hosts containing containers). Maximum one level of nesting.

conditional_formats

[object]

List of conditional formatting rules applied to fill values.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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.

enrichments [required]

[object]

Metric or event queries joined to the entity set. Each formula specifies a visual dimension.

formulas [required]

[object]

List of formulas that operate on queries, each assigned to a visual dimension.

alias

string

Expression alias.

dimension [required]

enum

Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; group is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: node,fill,size,group

formula [required]

string

String expression built from queries, formulas, and functions.

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

unit_name

string

The name of the unit.

queries [required]

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

audience_filters

object

Product Analytics/RUM audience filters.

accounts

[object]

filter_condition

string

An optional filter condition applied to the audience subquery.

segments

[object]

users

[object]

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

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.

sort

object

Options for sorting group by results.

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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 [required]

enum

Response format for the scalar formula request. Only scalar is supported. Allowed enum values: scalar

filter

string

Filter string for the entity set in tag format (for example, env:prod).

group_by

[object]

Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy.

column [required]

string

Column name from the entity table (for example, cloud_provider, tags, labels).

key

string

Key within the column for nested attribute types (for example, service within tags).

no_group_hosts

boolean

Whether to hide entities that have no group assignment.

no_metric_hosts

boolean

Whether to hide entities that have no enrichment data.

node_type [required]

enum

Which type of infrastructure entity to visualize in the host map. Allowed enum values: host,container,pod,cluster

request_type [required]

enum

Identifies this as an infrastructure-backed host map request. Allowed enum values: infrastructure_hostmap

style

object

Style configuration for the infrastructure host map.

fill_max

double

Maximum value for the fill color scale. Omit to use automatic scaling.

fill_min

double

Minimum value for the fill color scale. Omit to use automatic scaling.

palette

string

Color palette name or alias.

palette_flip

boolean

Whether to invert the color palette.

conditional_formats

[object]

List of conditional formatting rules applied to fill values.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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.

enrichments [required]

[object]

Metric or event queries joined to the entity set. Each formula specifies a visual dimension.

formulas [required]

[object]

List of formulas that operate on queries, each assigned to a visual dimension.

alias

string

Expression alias.

dimension [required]

enum

Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; group is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: node,fill,size,group

formula [required]

string

String expression built from queries, formulas, and functions.

number_format

object

Number format options for the widget.

unit

 <oneOf>

Number format unit.

Option 1

object

Canonical unit.

per_unit_name

string

The name of the unit per item.

type

enum

The type of unit scale. Allowed enum values: canonical_unit

unit_name

string

The name of the unit.

Option 2

object

Custom unit.

label

string

The label for the custom unit.

type

enum

The type of custom unit. Allowed enum values: custom_unit_label

unit_scale

object

The definition of NumberFormatUnitScale object.

type

enum

The type of unit scale. Allowed enum values: canonical_unit

unit_name

string

The name of the unit.

queries [required]

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

response_format [required]

enum

Response format for the scalar formula request. Only scalar is supported. Allowed enum values: scalar

filter

string

Filter string for the entity set in tag format (for example, env:prod).

group_by

[object]

Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy.

column [required]

string

Column name from the entity table (for example, cloud_provider, tags, labels).

key

string

Key within the column for nested attribute types (for example, service within tags).

no_group_hosts

boolean

Whether to hide entities that have no group assignment.

no_metric_hosts

boolean

Whether to hide entities that have no enrichment data.

node_type [required]

enum

Which type of infrastructure entity to visualize in the host map. Allowed enum values: host,container,pod,cluster

request_type [required]

enum

Identifies this as an infrastructure-backed host map request. Allowed enum values: infrastructure_hostmap

style

object

Style configuration for the infrastructure host map.

fill_max

double

Maximum value for the fill color scale. Omit to use automatic scaling.

fill_min

double

Minimum value for the fill color scale. Omit to use automatic scaling.

palette

string

Color palette name or alias.

palette_flip

boolean

Whether to invert the color palette.

conditional_formats

[object]

List of conditional formatting rules applied to fill values.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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.

enrichments

[object]

Metric or event queries joined to the entity set. Each formula specifies a visual dimension. Only used by the infrastructure-backed format.

formulas [required]

[object]

List of formulas that operate on queries, each assigned to a visual dimension.

alias

string

Expression alias.

dimension [required]

enum

Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; group is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: node,fill,size,group

formula [required]

string

String expression built from queries, formulas, and functions.

number_format

object

Number format options for the widget.

unit

 <oneOf>

Number format unit.

Option 1

object

Canonical unit.

per_unit_name

string

The name of the unit per item.

type

enum

The type of unit scale. Allowed enum values: canonical_unit

unit_name

string

The name of the unit.

Option 2

object

Custom unit.

label

string

The label for the custom unit.

type

enum

The type of custom unit. Allowed enum values: custom_unit_label

unit_scale

object

The definition of NumberFormatUnitScale object.

type

enum

The type of unit scale. Allowed enum values: canonical_unit

unit_name

string

The name of the unit.

queries [required]

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

accounts

[object]

filter_condition

string

An optional filter condition applied to the audience subquery.

segments

[object]

users

[object]

graph_filters

[object]

Graph filters.

name

string

Filter name.

operator

string

Filter operator.

target

object

Target for user journey search.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

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.

segments

[object]

users

[object]

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.

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 [required]

enum

Response format for the scalar formula request. Only scalar is supported. Allowed enum values: scalar

fill

object

DEPRECATED: Deprecated - Legacy metric-based format. Use the infrastructure-backed (request_type: infrastructure_hostmap) or DDSQL (request_type: data_projection) format instead.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

log_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

Query definition.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

filter

string

Filter string for the entity set in tag format (for example, env:prod). Only used by the infrastructure-backed format.

group_by

[object]

Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. Only used by the infrastructure-backed format.

column [required]

string

Column name from the entity table (for example, cloud_provider, tags, labels).

key

string

Key within the column for nested attribute types (for example, service within tags).

limit

int64

Maximum number of rows to return from the dataset query. Only used by the DDSQL format.

no_group_hosts

boolean

Whether to hide entities that have no group assignment.

no_metric_hosts

boolean

Whether to hide entities that have no enrichment data.

node_type

enum

Entity type to visualize. Only used by the infrastructure-backed format. Allowed enum values: host,container,pod,cluster

projection

object

Maps dataset columns to map dimensions (entity, optional parent for grouping, fill, size). Only used by the DDSQL format.

dimensions [required]

[object]

List of column-to-dimension mappings for the projection.

alias

string

Alias used to label the column instead of its name.

column [required]

string

Source column name from the dataset.

dimension [required]

enum

Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; group is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: node,fill,size,group

number_format

object

Number format options for the widget.

unit

 <oneOf>

Number format unit.

Option 1

object

Canonical unit.

per_unit_name

string

The name of the unit per item.

type

enum

The type of unit scale. Allowed enum values: canonical_unit

unit_name

string

The name of the unit.

Option 2

object

Custom unit.

label

string

The label for the custom unit.

type

enum

The type of custom unit. Allowed enum values: custom_unit_label

unit_scale

object

The definition of NumberFormatUnitScale object.

type

enum

The type of unit scale. Allowed enum values: canonical_unit

unit_name

string

The name of the unit.

type [required]

enum

Type of the host map projection. Allowed enum values: hostmap

query

object

Published-dataset query. Only used by the DDSQL format.

data_source [required]

enum

Identifies this as a published-dataset list query. Allowed enum values: dataset

dataset_id [required]

string

ID of the published dataset to query.

dataset_provider [required]

enum

Product page that published the dataset queried by a DatasetListQuery. ddsql_query is the only provider currently supported for host map widgets. Allowed enum values: ddsql_query

filter

string

Filter applied to the dataset's rows, using events-style search syntax.

limit

int64

Maximum number of rows to return from the dataset query.

sort

object

Sort configuration for a DatasetListQuery.

fields [required]

[object]

List of fields to sort the rows by, applied in order.

name [required]

string

Name of the field to sort on.

order [required]

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

request_type

enum

Identifies which host map request format the sibling fields on HostMapWidgetDefinitionRequests describe: an infrastructure-backed request or a DDSQL published-dataset request. Allowed enum values: infrastructure_hostmap,data_projection

size

object

DEPRECATED: Deprecated - Legacy metric-based format. Use the infrastructure-backed (request_type: infrastructure_hostmap) or DDSQL (request_type: data_projection) format instead.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

log_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

Query definition.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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

Style configuration for the infrastructure host map.

fill_max

double

Maximum value for the fill color scale. Omit to use automatic scaling.

fill_min

double

Minimum value for the fill color scale. Omit to use automatic scaling.

palette

string

Color palette name or alias.

palette_flip

boolean

Whether to invert the color palette.

scope

[string]

DEPRECATED: Deprecated - Only used by the legacy metric-based format. Use filter inside requests instead.

style

object

DEPRECATED: Deprecated - Only used by the legacy metric-based format. Use style inside requests instead.

fill_max

string

Max value to use to color the map.

fill_min

string

Min value to use to color the map.

palette

string

Color palette to apply to the widget.

palette_flip

boolean

Whether to flip the palette tones.

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the host map widget. Allowed enum values: hostmap

default: hostmap

Option 17

object

The iframe widget allows you to embed a portion of any other web page on your dashboard.

type [required]

enum

Type of the iframe widget. Allowed enum values: iframe

default: iframe

url [required]

string

URL of the iframe.

Option 18

object

The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.

has_background

boolean

Whether to display a background or not.

default: true

has_border

boolean

Whether to display a border or not.

default: true

horizontal_align

enum

Horizontal alignment. Allowed enum values: center,left,right

margin

enum

Size of the margins around the image. Note: small and large values are deprecated. Allowed enum values: sm,md,lg,small,large

sizing

enum

How to size the image on the widget. The values are based on the image object-fit CSS properties. Note: zoom, fit and center values are deprecated. Allowed enum values: fill,contain,cover,none,scale-down,zoom,fit,center

type [required]

enum

Type of the image widget. Allowed enum values: image

default: image

url [required]

string

URL of the image.

url_dark_theme

string

URL of the image in dark mode.

vertical_align

enum

Vertical alignment. Allowed enum values: center,top,bottom

Option 19

object

The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.

description

string

The description of the widget.

legend_size

string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

requests [required]

[object]

Request payload used to query items.

columns [required]

[object]

Widget columns.

field [required]

string

Widget column field.

width [required]

enum

Widget column width. Allowed enum values: auto,compact,full

query [required]

object

Updated list stream widget.

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.

aggregation [required]

enum

Aggregation value. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 5 more,max,avg,earliest,latest,most_frequent

facet

string

Facet name.

data_source [required]

enum

Source from which to query items to display in the stream. 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_stream

Show 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

query_string [required]

string

Widget query.

sort

object

Which column and order to sort by

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

states

[string]

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 [required]

enum

Widget response format. Allowed enum values: event_list

show_legend

boolean

Whether or not to display the legend on this widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 list stream widget. Allowed enum values: list_stream

default: list_stream

Option 20

object

The Log Stream displays a log flow matching the defined query.

columns

[string]

Which columns to display on the widget.

description

string

The description of the widget.

indexes

[string]

An array of index names to query in the stream. Use [] to query all indexes at once.

logset

string

DEPRECATED: ID of the log set to use.

message_display

enum

Amount of log lines to display Allowed enum values: inline,expanded-md,expanded-lg

query

string

Query to filter the log stream with.

show_date_column

boolean

Whether to show the date column or not

show_message_column

boolean

Whether to show the message column or not

sort

object

Which column and order to sort by

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 log stream widget. Allowed enum values: log_stream

default: log_stream

Option 21

object

The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.

color_preference

enum

Which color to use on the widget. Allowed enum values: background,text

count

int64

DEPRECATED: The number of monitors to display.

description

string

The description of the widget.

display_format

enum

What to display on the widget. Allowed enum values: counts,countsAndList,list

hide_zero_counts

boolean

Whether to show counts of 0 or not.

query [required]

string

Query to filter the monitors with.

show_last_triggered

boolean

Whether to show the time that has elapsed since the monitor/group triggered.

show_priority

boolean

Whether to show the priorities column.

sort

enum

Widget sorting methods. Allowed enum values: name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc

Show 7 more,status,desc,tags,asc,tags,desc,triggered,asc,triggered,desc,priority,asc,priority,desc

start

int64

DEPRECATED: The start of the list. Typically 0.

summary_type

enum

Which summary type should be used. Allowed enum values: monitors,groups,combined

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the monitor summary widget. Allowed enum values: manage_status

default: manage_status

Option 22

object

The notes and links widget is similar to free text widget, but allows for more formatting options.

background_color

string

Background color of the note.

content [required]

string

Content of the note.

font_size

string

Size of the text.

has_padding

boolean

Whether to add padding or not.

default: true

show_tick

boolean

Whether to show a tick or not.

text_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

tick_edge

enum

Define how you want to align the text on the widget. Allowed enum values: bottom,left,right,top

tick_pos

string

Where to position the tick on an edge.

type [required]

enum

Type of the note widget. Allowed enum values: note

default: note

vertical_align

enum

Vertical alignment. Allowed enum values: center,top,bottom

Option 23

object

The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.

background_color

string

Background color of the powerpack title.

banner_img

string

URL of image to display as a banner for the powerpack.

powerpack_id [required]

string

UUID of the associated powerpack.

show_title

boolean

Whether to show the title or not.

default: true

template_variables

object

Powerpack template variables.

controlled_by_powerpack

[object]

Template variables controlled at the powerpack level.

name [required]

string

The name of the variable.

prefix

string

The tag prefix associated with the variable.

values [required]

[string]

One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified.

controlled_externally

[object]

Template variables controlled by the external resource, such as the dashboard this powerpack is on.

name [required]

string

The name of the variable.

prefix

string

The tag prefix associated with the variable.

values [required]

[string]

One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified.

title

string

Title of the widget.

type [required]

enum

Type of the powerpack widget. Allowed enum values: powerpack

default: powerpack

Option 24

object

The point plot displays individual data points over time.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

legend

object

Legend configuration for the point plot widget.

type [required]

enum

Type of legend to show for the point plot widget. Allowed enum values: automatic,none

markers

[object]

List of markers for the widget.

display_type

string

Combination of:

  • A severity error, warning, ok, or info
  • A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be percentile.

label

string

Label to display over the marker.

time

string

Timestamp for the widget.

value [required]

string

Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with display_type set to percentile, this should be a numeric percentile value (for example, "90" for P90).

requests [required]

[object]

List of request configurations for the widget.

limit

int64

Maximum number of data points to return.

projection [required]

object

Projection configuration for the point plot widget.

dimensions [required]

[object]

List of dimension mappings for the projection.

alias

string

Alias for the column.

column [required]

string

Source column name from the dataset.

dimension [required]

enum

Dimension of the point plot. Allowed enum values: group,time,y,radius

extra_columns

[string]

Additional columns to include in the projection.

type [required]

enum

Type of the projection. Allowed enum values: point_plot

query [required]

object

Query configuration for a data projection request.

data_source [required]

string

Data source for the query.

indexes

[string]

List of indexes to query.

query_string [required]

string

The query string to filter events.

storage

string

Storage location for the query.

request_type [required]

enum

Type of a data projection request. Allowed enum values: data_projection

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 point plot widget. Allowed enum values: point_plot

default: point_plot

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

Option 25

object

Query values display the current value of a given metric, APM, or log query.

autoscale

boolean

Whether to use auto-scaling or not.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

custom_unit

string

Display a unit of your choice on the widget.

description

string

The description of the widget.

precision

int64

Number of decimals to show. If not defined, the widget uses the raw value.

requests [required]

[object]

Widget definition.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

comparison

object

Displays a change indicator showing a delta against a historical baseline.

directionality

enum

Which direction of change is considered an improvement, determining the indicator color. Allowed enum values: increase_better,decrease_better,neutral

default: neutral

duration [required]

object

The comparison period. Use a preset type value or set type to custom_timeframe and provide custom_timeframe with explicit millisecond epoch bounds.

custom_timeframe

object

Required when type is custom_timeframe. Fixed time range to compare against.

from [required]

int64

Start time in milliseconds since epoch.

to [required]

int64

End time in milliseconds since epoch.

type [required]

enum

The comparison window type. Allowed enum values: previous_timeframe,custom_timeframe,previous_day,previous_week,previous_month

type

enum

How the delta is expressed: absolute (raw difference), relative (percentage), or both. Allowed enum values: absolute,relative,both

default: absolute

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

text_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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

timeseries_background

object

Set a timeseries on the widget background.

type [required]

enum

Timeseries is made using an area or bars. Allowed enum values: bars,area

default: area

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

title

string

Title of your widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the query value widget. Allowed enum values: query_value

default: query_value

Option 26

object

The retention curve widget visualizes user retention rates over time.

description

string

The description of the widget.

requests [required]

[object]

List of Retention Curve 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_frequent

Show 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.

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.

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

source

string

Source field.

target [required]

enum

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 curve widget. Allowed enum values: retention_curve

style

object

Style configuration for retention curve.

palette

string

Color palette for the retention curve.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 Retention Curve widget. Allowed enum values: retention_curve

default: retention_curve

Option 27

object

Run workflow is widget that allows you to run a workflow from a dashboard.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

inputs

[object]

Array of workflow inputs to map to dashboard template variables.

name [required]

string

Name of the workflow input.

value [required]

string

Dashboard template variable. Can be suffixed with '.value' or '.key'.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 run workflow widget. Allowed enum values: run_workflow

default: run_workflow

workflow_id [required]

string

Workflow id.

Option 28

object

Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.

description

string

The description of the widget.

requests [required]

[object]

Array of one request object to display in the widget.

query [required]

object

Updated SLO List widget.

limit

int64

Maximum number of results to display in the table.

default: 100

query_string [required]

string

Widget query.

sort

[object]

Options for sorting results.

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

request_type [required]

enum

Widget request type. Allowed enum values: slo_list

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the SLO List widget. Allowed enum values: slo_list

default: slo_list

Option 29

object

Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.

additional_query_filters

string

Additional filters applied to the SLO query.

description

string

The description of the widget.

global_time_target

string

Defined global time target.

show_error_budget

boolean

Defined error budget.

slo_id

string

ID of the SLO displayed.

time_windows

[string]

Times being monitored.

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the SLO widget. Allowed enum values: slo

default: slo

view_mode

enum

Define how you want the SLO to be displayed. Allowed enum values: overall,component,both

view_type [required]

string

Type of view displayed by the widget.

default: detail

Option 30

object

The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.

color_by_groups

[string]

List of groups used for colors.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

requests [required]

object

Widget definition.

table

object

Scatterplot request containing formulas and functions.

formulas

[object]

List of Scatterplot formulas that operate on queries.

alias

string

Expression alias.

dimension [required]

enum

Dimension of the Scatterplot. Allowed enum values: x,y,radius,color

formula [required]

string

String expression built from queries, formulas, and functions.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

accounts

[object]

filter_condition

string

An optional filter condition applied to the audience subquery.

segments

[object]

users

[object]

graph_filters

[object]

Graph filters.

name

string

Filter name.

operator

string

Filter operator.

target

object

Target for user journey search.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

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.

segments

[object]

users

[object]

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.

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

x

object

Updated scatter plot.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

log_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

Query definition.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

y

object

Updated scatter plot.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

log_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

Query definition.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 scatter plot widget. Allowed enum values: scatterplot

default: scatterplot

xaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

Option 31

object

The Sankey diagram visualizes the flow of data between categories, stages or sets of values.

requests [required]

[ <oneOf>]

List of Sankey widget requests.

Option 1

object

Sankey widget request for Product Analytics or RUM data source.

query [required]

object

Query configuration for Product Analytics or RUM Sankey widget.

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.

data_source [required]

enum

Product Analytics or RUM data source type. Allowed enum values: rum,product_analytics

default: product_analytics

entries_per_step

int64

Entries per step.

join_keys

object

Join keys.

primary [required]

string

Primary join key.

secondary

[string]

Secondary join keys.

mode [required]

enum

Sankey mode for Product Analytics or RUM queries. Allowed enum values: source,target

default: source

number_of_steps

int64

Number of steps.

occurrences

object

Filter applied to occurrence counts when building a Product Analytics audience.

operator

string

The comparison operator used for the occurrence filter (for example: gt, lt, eq).

value

string

The threshold value to compare occurrence counts against.

query_string [required]

string

RUM event search query used to filter views or actions.

source

string

Source.

subquery_id

string

Subquery ID.

target

string

Target.

request_type [required]

enum

Type of the Sankey widget. Allowed enum values: sankey

default: sankey

Option 2

object

Sankey widget request for network data source.

query [required]

object

Query configuration for Sankey network widget.

compute

object

Compute aggregation for network 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_frequent

Show 1 more,sum

Option 2

string

Percentile aggregation.

metric [required]

string

Metric to aggregate.

data_source [required]

enum

Network data source type. Allowed enum values: network_device_flows,network

default: network

group_by [required]

[string]

Fields to group by.

limit [required]

int64

Maximum number of results.

mode

enum

Sankey mode for network queries. Allowed enum values: target

default: target

query_string [required]

string

Query string for filtering network data.

should_exclude_missing

boolean

Whether to exclude missing values.

sort

object

Sort configuration for network queries.

field

string

Field to sort by.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

request_type [required]

enum

Type of request for network Sankey widget. Allowed enum values: netflow_sankey

default: netflow_sankey

show_other_links

boolean

Whether to show links for "other" category.

sort_nodes

boolean

Whether to sort nodes in the Sankey diagram.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 Sankey widget. Allowed enum values: sankey

default: sankey

Option 32

object

This widget displays a map of a service to all of the services that call it, and all of the services that it calls.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

filters [required]

[string]

Your environment and primary tag (or * if enabled for your account).

service [required]

string

The ID of the service you want to map.

title

string

The title of your widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the service map widget. Allowed enum values: servicemap

default: servicemap

Option 33

object

The service summary displays the graphs of a chosen service in your dashboard.

description

string

The description of the widget.

display_format

enum

Number of columns to display. Allowed enum values: one_column,two_column,three_column

env [required]

string

APM environment.

service [required]

string

APM service.

show_breakdown

boolean

Whether to show the latency breakdown or not.

show_distribution

boolean

Whether to show the latency distribution or not.

show_errors

boolean

Whether to show the error metrics or not.

show_hits

boolean

Whether to show the hits metrics or not.

show_latency

boolean

Whether to show the latency metrics or not.

show_resource_list

boolean

Whether to show the resource list or not.

size_format

enum

Size of the widget. Allowed enum values: small,medium,large

span_name [required]

string

APM span name.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 service summary widget. Allowed enum values: trace_service

default: trace_service

Option 34

object

The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service)

has_uniform_y_axes

boolean

Normalize y axes across graphs

size [required]

enum

Size of the individual graphs in the split. Allowed enum values: xs,sm,md,lg

source_widget_definition [required]

 <oneOf>

The original widget we are splitting on.

Option 1

object

The 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Define request widget style.

line_type

enum

Type of lines displayed. Allowed enum values: dashed,dotted,solid

line_width

enum

Width of line displayed. Allowed enum values: normal,thick,thin

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,1w

Show 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 2

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.

See the dedicated Request JSON schema documentation to learn how to build the REQUEST_SCHEMA.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

change_type

enum

Show the absolute or the relative change. Allowed enum values: absolute,relative

compare_to

enum

Timeframe used for the change comparison. Allowed enum values: hour_before,day_before,week_before,month_before

event_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

increase_good

boolean

Whether to show increase as good.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

order_by

enum

What to order by. Allowed enum values: change,name,present,past

order_dir

enum

Widget sorting methods. Allowed enum values: asc,desc

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Query definition. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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,1w

Show 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 3

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.

columns

[object]

Widget columns.

field [required]

string

Widget column field.

width [required]

enum

Widget column width. Allowed enum values: auto,compact,full

conditional_formats

[object]

Threshold (numeric) conditional formatting rules may be used by a regions layer.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: The widget metrics query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

aggregation [required]

enum

Aggregation value. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 5 more,max,avg,earliest,latest,most_frequent

facet

string

Facet name.

data_source [required]

enum

Source from which to query items to display in the stream. 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_stream

Show 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

query_string [required]

string

Widget query.

sort

object

Which column and order to sort by

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

states

[string]

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

The style to apply to the request for points layer.

color_by

string

The category to color the points by.

text_formats

[object]

Text formatting rules may be used by a points layer.

custom_bg_color

string

Hex representation of the custom background color. Used with custom background palette option.

custom_fg_color

string

Hex representation of the custom text color. Used with custom text palette option.

match [required]

object

Match rule for the table widget text format.

type [required]

enum

Match or compare option. Allowed enum values: is,is_not,contains,does_not_contain,starts_with,ends_with

value [required]

string

Table Widget Match String.

palette

enum

Color-on-color palette to highlight replaced text. Allowed enum values: white_on_red,white_on_yellow,white_on_green,black_on_light_red,black_on_light_yellow,black_on_light_green,red_on_white,yellow_on_white,green_on_white,custom_bg

Show 1 more,custom_text

default: white_on_green

replace

 <oneOf>

Replace rule for the table widget text format.

Option 1

object

Match All definition.

type [required]

enum

Table widget text format replace all type. Allowed enum values: all

with [required]

string

Replace All type.

Option 2

object

Match Sub-string definition.

substring [required]

string

Text that will be replaced.

type [required]

enum

Table widget text format replace sub-string type. Allowed enum values: substring

with [required]

string

Text that will replace original sub-string.

style [required]

object

The style to apply to the widget.

palette [required]

string

The color palette to apply to the widget.

palette_flip [required]

boolean

Whether to flip the palette tones.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 4

object

Query values display the current value of a given metric, APM, or log query.

autoscale

boolean

Whether to use auto-scaling or not.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

custom_unit

string

Display a unit of your choice on the widget.

description

string

The description of the widget.

precision

int64

Number of decimals to show. If not defined, the widget uses the raw value.

requests [required]

[object]

Widget definition.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

comparison

object

Displays a change indicator showing a delta against a historical baseline.

directionality

enum

Which direction of change is considered an improvement, determining the indicator color. Allowed enum values: increase_better,decrease_better,neutral

default: neutral

duration [required]

object

The comparison period. Use a preset type value or set type to custom_timeframe and provide custom_timeframe with explicit millisecond epoch bounds.

custom_timeframe

object

Required when type is custom_timeframe. Fixed time range to compare against.

from [required]

int64

Start time in milliseconds since epoch.

to [required]

int64

End time in milliseconds since epoch.

type [required]

enum

The comparison window type. Allowed enum values: previous_timeframe,custom_timeframe,previous_day,previous_week,previous_month

type

enum

How the delta is expressed: absolute (raw difference), relative (percentage), or both. Allowed enum values: absolute,relative,both

default: absolute

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

text_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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

timeseries_background

object

Set a timeseries on the widget background.

type [required]

enum

Timeseries is made using an area or bars. Allowed enum values: bars,area

default: area

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

title

string

Title of your widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the query value widget. Allowed enum values: query_value

default: query_value

Option 5

object

The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.

color_by_groups

[string]

List of groups used for colors.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

requests [required]

object

Widget definition.

table

object

Scatterplot request containing formulas and functions.

formulas

[object]

List of Scatterplot formulas that operate on queries.

alias

string

Expression alias.

dimension [required]

enum

Dimension of the Scatterplot. Allowed enum values: x,y,radius,color

formula [required]

string

String expression built from queries, formulas, and functions.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

audience_filters

object

Product Analytics/RUM audience filters.

accounts

[object]

filter_condition

string

An optional filter condition applied to the audience subquery.

segments

[object]

users

[object]

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

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.

sort

object

Options for sorting group by results.

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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

x

object

Updated scatter plot.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

log_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

Query definition.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

y

object

Updated scatter plot.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

log_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

Query definition.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 scatter plot widget. Allowed enum values: scatterplot

default: scatterplot

xaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

Option 6

object

Sunbursts are spot on to highlight how groups contribute to the total of a query.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

hide_total

boolean

Show the total value in this widget.

legend

 <oneOf>

Configuration of the legend.

Option 1

object

Configuration of table-based legend.

type [required]

enum

Whether or not to show a table legend. Allowed enum values: table,none

Option 2

object

Configuration of inline or automatic legends.

hide_percent

boolean

Whether to hide the percentages of the groups.

hide_value

boolean

Whether to hide the values of the groups.

type [required]

enum

Whether to show the legend inline or let it be automatically generated. Allowed enum values: inline,automatic

requests [required]

[object]

List of sunburst widget requests.

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Widget style definition.

palette

string

Color palette to apply to the widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 Sunburst widget. Allowed enum values: sunburst

default: sunburst

Option 7

object

The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

has_search_bar

enum

Controls the display of the search bar. Allowed enum values: always,never,auto

requests [required]

[object]

Widget definition.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

alias

string

The column name (defaults to the metric name).

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

apm_stats_query

object

The APM stats query for table and distributions widgets.

columns

[object]

Column properties used by the front end for display.

alias

string

A user-assigned alias for the column.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

name [required]

string

Column name.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

env [required]

string

Environment name.

name [required]

string

Operation name associated with service.

primary_tag [required]

string

The organization's host group name and value.

resource

string

Resource name.

row_type [required]

enum

The level of detail for the request. Allowed enum values: service,resource,span

service [required]

string

Service name.

cell_display_mode

[string]

A list of display modes for each table cell.

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

limit

int64

For metric queries, the number of lines to show in the table. Only one request should have this property.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Query definition. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

text_formats

[array]

List of text formats for columns produced by tags.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 table widget. Allowed enum values: query_table

default: query_table

Option 8

object

The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

events

[object]

DEPRECATED: List of widget events. Deprecated - Use overlay request type instead.

q [required]

string

Query definition.

tags_execution

string

The execution method for multi-value filters.

legend_columns

[string]

Columns displayed in the legend.

legend_layout

enum

Layout of the legend. Allowed enum values: auto,horizontal,vertical

legend_size

string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

markers

[object]

List of markers.

display_type

string

Combination of:

  • A severity error, warning, ok, or info
  • A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be percentile.

label

string

Label to display over the marker.

time

string

Timestamp for the widget.

value [required]

string

Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with display_type set to percentile, this should be a numeric percentile value (for example, "90" for P90).

requests [required]

[object]

List of timeseries widget requests.

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

display_type

enum

Type of display to use for the request. Allowed enum values: area,bars,line,overlay

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

metadata

[object]

Used to define expression aliases.

alias_name

string

Expression alias.

expression [required]

string

Expression name.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

on_right_yaxis

boolean

Whether or not to display a second y-axis on the right.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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

Define request widget style for timeseries widgets.

has_value_labels

boolean

If true, the value is displayed as a label relative to the data point.

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.

right_yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

show_legend

boolean

(screenboard only) Show the legend for this widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 timeseries widget. Allowed enum values: timeseries

default: timeseries

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

Option 9

object

The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

requests [required]

[object]

List of top list 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Define request widget style.

line_type

enum

Type of lines displayed. Allowed enum values: dashed,dotted,solid

line_width

enum

Width of line displayed. Allowed enum values: normal,thick,thin

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 top list widget.

display

 <oneOf>

Top list widget display options.

Option 1

object

Top list widget stacked display options.

legend

enum

Top list widget stacked legend behavior. Allowed enum values: automatic,inline,none

type [required]

enum

Top list widget stacked display type. Allowed enum values: stacked

default: stacked

Option 2

object

Top list widget flat display.

type [required]

enum

Top list widget flat display type. Allowed enum values: flat

default: flat

palette

string

Color palette to apply to the widget.

scaling

enum

Top list widget scaling definition. Allowed enum values: absolute,relative

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 top list widget. Allowed enum values: toplist

default: toplist

Option 10

object

The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team.

color_by

enum

DEPRECATED: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: user

default: user

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

group_by

enum

DEPRECATED: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: user,family,process

requests [required]

[object]

List of treemap widget requests.

formulas

[object]

List of formulas that operate on queries.

alias

string

Expression alias.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

cell_display_mode_options

object

Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).

trend_type

enum

Trend type for the cell display mode options. Allowed enum values: area,line,bars

y_scale

enum

Y scale for the cell display mode options. Allowed enum values: shared,independent

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

q

string

DEPRECATED: The widget metrics query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

graph_filters

[object]

Graph filters.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Define request widget style.

line_type

enum

Type of lines displayed. Allowed enum values: dashed,dotted,solid

line_width

enum

Width of line displayed. Allowed enum values: normal,thick,thin

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.

size_by

enum

DEPRECATED: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: pct_cpu,pct_mem

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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.

type [required]

enum

Type of the treemap widget. Allowed enum values: treemap

default: treemap

split_config [required]

object

Encapsulates all user choices about how to split a graph.

limit [required]

int64

Maximum number of graphs to display in the widget.

sort [required]

object

Controls the order in which graphs appear in the split.

compute

object

Defines the metric and aggregation used as the sort value.

aggregation [required]

string

How to aggregate the sort metric for the purposes of ordering.

metric [required]

string

The metric to use for sorting graphs.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

split_dimensions [required]

[object]

The dimension(s) on which to split the graph

one_graph_per [required]

string

The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag.

static_splits

[array]

Manual selection of tags making split graph widget static

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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.

type [required]

enum

Type of the split graph widget Allowed enum values: split_group

default: split_group

Option 35

object

Sunbursts are spot on to highlight how groups contribute to the total of a query.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

hide_total

boolean

Show the total value in this widget.

legend

 <oneOf>

Configuration of the legend.

Option 1

object

Configuration of table-based legend.

type [required]

enum

Whether or not to show a table legend. Allowed enum values: table,none

Option 2

object

Configuration of inline or automatic legends.

hide_percent

boolean

Whether to hide the percentages of the groups.

hide_value

boolean

Whether to hide the values of the groups.

type [required]

enum

Whether to show the legend inline or let it be automatically generated. Allowed enum values: inline,automatic

requests [required]

[object]

List of sunburst widget requests.

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Widget style definition.

palette

string

Color palette to apply to the widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 Sunburst widget. Allowed enum values: sunburst

default: sunburst

Option 36

object

The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

has_search_bar

enum

Controls the display of the search bar. Allowed enum values: always,never,auto

requests [required]

[object]

Widget definition.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

alias

string

The column name (defaults to the metric name).

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

apm_stats_query

object

The APM stats query for table and distributions widgets.

columns

[object]

Column properties used by the front end for display.

alias

string

A user-assigned alias for the column.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

name [required]

string

Column name.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

env [required]

string

Environment name.

name [required]

string

Operation name associated with service.

primary_tag [required]

string

The organization's host group name and value.

resource

string

Resource name.

row_type [required]

enum

The level of detail for the request. Allowed enum values: service,resource,span

service [required]

string

Service name.

cell_display_mode

[string]

A list of display modes for each table cell.

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

limit

int64

For metric queries, the number of lines to show in the table. Only one request should have this property.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Query definition. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

text_formats

[array]

List of text formats for columns produced by tags.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 table widget. Allowed enum values: query_table

default: query_table

Option 37

object

The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

events

[object]

DEPRECATED: List of widget events. Deprecated - Use overlay request type instead.

q [required]

string

Query definition.

tags_execution

string

The execution method for multi-value filters.

legend_columns

[string]

Columns displayed in the legend.

legend_layout

enum

Layout of the legend. Allowed enum values: auto,horizontal,vertical

legend_size

string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

markers

[object]

List of markers.

display_type

string

Combination of:

  • A severity error, warning, ok, or info
  • A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be percentile.

label

string

Label to display over the marker.

time

string

Timestamp for the widget.

value [required]

string

Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with display_type set to percentile, this should be a numeric percentile value (for example, "90" for P90).

requests [required]

[object]

List of timeseries widget requests.

apm_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

display_type

enum

Type of display to use for the request. Allowed enum values: area,bars,line,overlay

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

metadata

[object]

Used to define expression aliases.

alias_name

string

Expression alias.

expression [required]

string

Expression name.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

on_right_yaxis

boolean

Whether or not to display a second y-axis on the right.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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

Define request widget style for timeseries widgets.

has_value_labels

boolean

If true, the value is displayed as a label relative to the data point.

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.

right_yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

show_legend

boolean

(screenboard only) Show the legend for this widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 timeseries widget. Allowed enum values: timeseries

default: timeseries

yaxis

object

Axis controls for the widget.

include_zero

boolean

Set to true to include zero.

label

string

The label of the axis to display on the graph. Only usable on Scatterplot Widgets.

max

string

Specifies maximum numeric value to show on the axis. Defaults to auto.

default: auto

min

string

Specifies minimum numeric value to show on the axis. Defaults to auto.

default: auto

scale

string

Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).

default: linear

Option 38

object

The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

requests [required]

[object]

List of top list 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Define request widget style.

line_type

enum

Type of lines displayed. Allowed enum values: dashed,dotted,solid

line_width

enum

Width of line displayed. Allowed enum values: normal,thick,thin

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 top list widget.

display

 <oneOf>

Top list widget display options.

Option 1

object

Top list widget stacked display options.

legend

enum

Top list widget stacked legend behavior. Allowed enum values: automatic,inline,none

type [required]

enum

Top list widget stacked display type. Allowed enum values: stacked

default: stacked

Option 2

object

Top list widget flat display.

type [required]

enum

Top list widget flat display type. Allowed enum values: flat

default: flat

palette

string

Color palette to apply to the widget.

scaling

enum

Top list widget scaling definition. Allowed enum values: absolute,relative

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 top list widget. Allowed enum values: toplist

default: toplist

Option 39

object

This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

requests [required]

[object]

One or more Topology requests.

query

object

Query to service-based topology data sources like the service map or data streams.

data_source

enum

Name of the data source Allowed enum values: data_streams,service_map

filters

[string]

Your environment and primary tag (or * if enabled for your account).

service

string

Name of the service

request_type

enum

Widget request type. Allowed enum values: topology

title

string

Title of your widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the topology map widget. Allowed enum values: topology_map

default: topology_map

Option 40

object

The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team.

color_by

enum

DEPRECATED: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: user

default: user

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

description

string

The description of the widget.

group_by

enum

DEPRECATED: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: user,family,process

requests [required]

[object]

List of treemap widget requests.

formulas

[object]

List of formulas that operate on queries.

alias

string

Expression alias.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

cell_display_mode_options

object

Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).

trend_type

enum

Trend type for the cell display mode options. Allowed enum values: area,line,bars

y_scale

enum

Y scale for the cell display mode options. Allowed enum values: shared,independent

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

q

string

DEPRECATED: The widget metrics query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

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.

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

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Define request widget style.

line_type

enum

Type of lines displayed. Allowed enum values: dashed,dotted,solid

line_width

enum

Width of line displayed. Allowed enum values: normal,thick,thin

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.

size_by

enum

DEPRECATED: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: pct_cpu,pct_mem

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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.

type [required]

enum

Type of the treemap widget. Allowed enum values: treemap

default: treemap

Option 41

object

Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations.

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

requests [required]

[ <oneOf>]

List of data requests for the wildcard widget.

Option 1

object

An updated treemap widget.

formulas

[object]

List of formulas that operate on queries.

alias

string

Expression alias.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

cell_display_mode_options

object

Cell display mode options for the widget formula. (only if cell_display_mode is set to trend).

trend_type

enum

Trend type for the cell display mode options. Allowed enum values: area,line,bars

y_scale

enum

Y scale for the cell display mode options. Allowed enum values: shared,independent

conditional_formats

[object]

List of conditional formats.

comparator [required]

enum

Comparator to apply. Allowed enum values: =,>,>=,<,<=

custom_bg_color

string

Color palette to apply to the background, same values available as palette.

custom_fg_color

string

Color palette to apply to the foreground, same values available as palette.

hide_value

boolean

True hides values.

image_url

string

Displays an image as the background.

metric

string

Metric from the request to correlate this conditional format with.

palette [required]

enum

Color palette to apply. Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

q

string

DEPRECATED: The widget metrics query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

accounts

[object]

filter_condition

string

An optional filter condition applied to the audience subquery.

segments

[object]

users

[object]

graph_filters

[object]

Graph filters.

name

string

Filter name.

operator

string

Filter operator.

target

object

Target for user journey search.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

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.

segments

[object]

users

[object]

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.

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

sort

object

The controls for sorting the widget.

count

int64

The number of items to limit the widget to.

order_by

[ <oneOf>]

The array of items to sort the widget by in order.

Option 1

object

The formula to sort the widget by.

index [required]

int64

The index of the formula to sort by.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to formula. Allowed enum values: formula

Option 2

object

The group to sort the widget by.

name [required]

string

The name of the group.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

type [required]

enum

Set the sort type to group. Allowed enum values: group

style

object

Define request widget style.

line_type

enum

Type of lines displayed. Allowed enum values: dashed,dotted,solid

line_width

enum

Width of line displayed. Allowed enum values: normal,thick,thin

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.

Option 2

object

Updated timeseries widget.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

audit_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

display_type

enum

Type of display to use for the request. Allowed enum values: area,bars,line,overlay

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

metadata

[object]

Used to define expression aliases.

alias_name

string

Expression alias.

expression [required]

string

Expression name.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

on_right_yaxis

boolean

Whether or not to display a second y-axis on the right.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

accounts

[object]

filter_condition

string

An optional filter condition applied to the audience subquery.

segments

[object]

users

[object]

graph_filters

[object]

Graph filters.

name

string

Filter name.

operator

string

Filter operator.

target

object

Target for user journey search.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

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.

segments

[object]

users

[object]

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.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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

Define request widget style for timeseries widgets.

has_value_labels

boolean

If true, the value is displayed as a label relative to the data point.

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.

Option 3

object

Updated list stream widget.

columns [required]

[object]

Widget columns.

field [required]

string

Widget column field.

width [required]

enum

Widget column width. Allowed enum values: auto,compact,full

query [required]

object

Updated list stream widget.

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.

aggregation [required]

enum

Aggregation value. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 5 more,max,avg,earliest,latest,most_frequent

facet

string

Facet name.

data_source [required]

enum

Source from which to query items to display in the stream. 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_stream

Show 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

query_string [required]

string

Widget query.

sort

object

Which column and order to sort by

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

states

[string]

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 [required]

enum

Widget response format. Allowed enum values: event_list

Option 4

object

Updated distribution widget.

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

apm_stats_query

object

The APM stats query for table and distributions widgets.

columns

[object]

Column properties used by the front end for display.

alias

string

A user-assigned alias for the column.

cell_display_mode

enum

Define a display mode for the table cell. Allowed enum values: number,bar,trend

name [required]

string

Column name.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

env [required]

string

Environment name.

name [required]

string

Operation name associated with service.

primary_tag [required]

string

The organization's host group name and value.

resource

string

Resource name.

row_type [required]

enum

The level of detail for the request. Allowed enum values: service,resource,span

service [required]

string

Service name.

event_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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_white

Show 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

unit_name

string

The name of the unit.

style

object

Styling options for widget formulas.

palette

string

The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

palette_index

int64

Index specifying which color to use within the palette.

log_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

network_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

process_query

object

DEPRECATED: Deprecated - Use queries and formulas instead.

filter_by

[string]

List of processes.

limit

int64

Max number of items in the filter list.

metric [required]

string

Your chosen metric.

search_by

string

Your chosen search term.

profile_metrics_query

object

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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

q

string

DEPRECATED: Widget query. Deprecated - Use queries and formulas instead.

queries

[ <oneOf>]

List of queries that can be returned directly or used in formulas.

Option 1

object

A formula and functions metrics query.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for metrics queries. Allowed enum values: metrics

name [required]

string

Name of the query for use in formulas.

query [required]

string

Metrics query definition.

semantic_mode

enum

Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: combined,native

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

Process query using formulas and functions.

aggregator

enum

The aggregation methods available for metrics queries. Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data sources that rely on the process backend. Allowed enum values: process,container

is_normalized_cpu

boolean

Whether to normalize the CPU percentages.

limit

int64

Number of hits to return.

metric [required]

string

Process metric name.

name [required]

string

Name of query for use in formulas.

sort

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

tag_filters

[string]

An array of tags to filter by.

text_filter

string

Text to use as filter.

Option 4

object

A formula and functions APM dependency stats query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for APM dependency stats queries. Allowed enum values: apm_dependency_stats

env [required]

string

APM environment.

is_upstream

boolean

Determines whether stats for upstream or downstream dependencies should be queried.

name [required]

string

Name of query to use in formulas.

operation_name [required]

string

Name of operation on service.

primary_tag_name

string

The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

primary_tag_value

string

Filter APM data by the second primary tag. primary_tag_name must also be specified.

resource_name [required]

string

APM resource.

service [required]

string

APM service.

stat [required]

enum

APM statistic. Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count

Option 5

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 1 more,latency_p99

Option 6

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_p99

Show 6 more,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex

Option 7

object

A formula and functions metrics query.

additional_query_filters

string

Additional filters applied to the SLO query.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for SLO measures queries. Allowed enum values: slo

group_mode

enum

Group mode to query measures. Allowed enum values: overall,components

measure [required]

enum

SLO measures queries. Allowed enum values: good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown

name

string

Name of the query for use in formulas.

slo_id [required]

string

ID of an SLO to query measures.

slo_query_type

enum

Name of the query for use in formulas. Allowed enum values: metric,monitor,time_slice

Option 8

object

A formula and functions Cloud Cost query.

aggregator

enum

Aggregator used for the request. Allowed enum values: avg,last,max,min,sum,percentile

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for Cloud Cost queries. Allowed enum values: cloud_cost

name [required]

string

Name of the query for use in formulas.

query [required]

string

Query for Cloud Cost data.

Option 9

object

A formula and functions Product Analytics Extended query for advanced analytics features.

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.

compute [required]

object

Compute configuration for Product Analytics Extended queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

Event indexes to query.

name [required]

string

Name of the query for use in formulas.

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.

Option 10

object

A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.

compute [required]

object

Compute configuration for User Journey formula queries.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

double

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.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

target

object

Target for user journey search.

end

string

End value.

start

string

Start value.

type [required]

string

Target type.

value

string

Target value.

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.

audience_filters

object

Product Analytics/RUM audience filters.

accounts

[object]

filter_condition

string

An optional filter condition applied to the audience subquery.

segments

[object]

users

[object]

graph_filters

[object]

Graph filters.

name

string

Filter name.

operator

string

Filter operator.

target

object

Target for user journey search.

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.

step_aliases

object

Step aliases mapping.

<any-key>

string

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.

Option 1

enum

Standard aggregation types for events-based queries. Allowed enum values: avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent

Show 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

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.

order

enum

Widget sorting methods. Allowed enum values: asc,desc

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.

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.

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.

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.

segments

[object]

users

[object]

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.

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

Option 2

object

A formula and functions events query.

compute [required]

object

Compute options.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

interval

int64

A time interval in milliseconds.

metric

string

Measurable attribute to compute.

cross_org_uuids

[string]

The source organization UUID for cross organization queries. Feature in Private Beta.

data_source [required]

enum

Data source for event platform-based queries. Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines

Show 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.

facet [required]

string

Event facet.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

Option 2

object

Flat group by configuration using multiple event facet fields.

fields [required]

[string]

List of event facets to group by.

limit

int64

Number of groups to return.

sort

object

Options for sorting group by results.

aggregation [required]

enum

Aggregation methods for event platform queries. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 2 more,max,avg

metric

string

Metric used for sorting group by results.

order

enum

Direction of sort. Allowed enum values: asc,desc

default: desc

indexes

[string]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

name [required]

string

Name of the query for use in formulas.

search

object

Search options.

query [required]

string

Events search string.

storage

string

Option for storage location. Feature in Private Beta.

Option 3

object

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

env [required]

string

APM environment.

group_by

[string]

Array of fields to group results by.

name [required]

string

Name of this query to use in formulas.

operation_name

string

Name of operation on service.

primary_tag_name

string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

primary_tag_value

string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

resource_name

string

APM resource name.

service [required]

string

APM service name.

stat [required]

enum

APM resource stat name. Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95

Show 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_p99

Show 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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

security_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.

facet [required]

string

Facet name.

limit

int64

Maximum number of items in the group.

sort

object

Define a sorting method.

aggregation [required]

string

The aggregation method.

facet

string

Facet name.

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

index

string

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.

specification [required]

object

Vega or Vega-Lite specification for custom visualization rendering. See https://vega.github.io/vega-lite/ for the full grammar reference.

contents [required]

object

The Vega or Vega-Lite JSON specification object.

type [required]

enum

Type of specification used by the wildcard widget. Allowed enum values: vega,vega-lite

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 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 wildcard widget. Allowed enum values: wildcard

default: wildcard

id

int64

ID of the widget.

layout

object

The layout for a widget on a free or new dashboard layout dashboard.

height [required]

int64

The height of the widget. Should be a non-negative integer.

is_column_break

boolean

Whether the widget should be the first one on the second column in high density or not. Note: Only for the new dashboard layout and only one widget in the dashboard should have this property set to true.

width [required]

int64

The width of the widget. Should be a non-negative integer.

x [required]

int64

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

y [required]

int64

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

{
  "author_handle": "[email protected]",
  "author_name": "John Doe",
  "created_at": "2019-09-19T10:00:00.000Z",
  "default_timeframe": {
    "type": "live",
    "unit": "minute",
    "value": 4
  },
  "description": "string",
  "id": "123-abc-456",
  "is_read_only": false,
  "layout_type": "ordered",
  "modified_at": "2019-09-19T10:00:00.000Z",
  "notify_list": [],
  "reflow_type": "string",
  "restricted_roles": [],
  "tabs": [
    {
      "id": "",
      "name": "L",
      "widget_ids": [
        0
      ]
    }
  ],
  "tags": [],
  "template_variable_presets": [
    {
      "name": "string",
      "template_variables": [
        {
          "name": "string",
          "value": "string",
          "values": []
        }
      ]
    }
  ],
  "template_variables": [
    {
      "available_values": [
        "my-host",
        "host1",
        "host2"
      ],
      "default": "my-host",
      "defaults": [
        "my-host-1",
        "my-host-2"
      ],
      "name": "host1",
      "prefix": "host",
      "type": "group"
    }
  ],
  "title": "",
  "url": "/dashboard/123-abc-456/example-dashboard-title",
  "widgets": [
    {
      "definition": {
        "requests": {
          "fill": {
            "q": "avg:system.cpu.user{*}"
          }
        },
        "type": "hostmap"
      },
      "id": "integer",
      "layout": {
        "height": 0,
        "is_column_break": false,
        "width": 0,
        "x": 0,
        "y": 0
      }
    }
  ]
}

Authentication Error

Error response object.

Expand All

フィールド

種類

説明

errors [required]

[string]

Array of errors returned by the API.

{
  "errors": [
    "Bad Request"
  ]
}

Item Not Found

Error response object.

Expand All

フィールド

種類

説明

errors [required]

[string]

Array of errors returned by the API.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

Error response object.

Expand All

フィールド

種類

説明

errors [required]

[string]

Array of errors returned by the API.

{
  "errors": [
    "Bad Request"
  ]
}

コード例

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

                
"""
Get a dashboard returns "OK" response
"""

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

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

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

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get a dashboard returns "OK" response

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

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

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
require 'rubygems'
require 'dogapi'

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

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

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

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get a dashboard returns "OK" response

package main

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

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

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

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

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

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

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get a dashboard returns "OK" response

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

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

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

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

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
from datadog import initialize, api

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

initialize(**options)

dashboard_id = '<DASHBOARD_ID>'

api.Dashboard.get(dashboard_id)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"
// Get a dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;

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

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Get a dashboard returns "OK" response
 */

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

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

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

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

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

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

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