Récupérer un dashboard
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}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.uk1.datadoghq.com/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}Présentation
Récupérez un dashboard à l'aide de l'ID spécifié.
OAuth apps require the dashboards_read authorization scope to access this endpoint.
Arguments
Paramètres du chemin
dashboard_id [required]The ID of the dashboard.
Réponse
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.
author_handleIdentifier of the dashboard author.
author_nameName of the dashboard author.
created_atCreation date of the dashboard.
default_timeframeThe default timeframe applied when opening the dashboard. Set to null to clear.
<type=live>A live dashboard timeframe.
type [required]Type of live timeframe.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the live timeframe span.
<type=fixed>A fixed dashboard timeframe.
from [required]Start time in milliseconds since epoch.
to [required]End time in milliseconds since epoch.
type [required]Type of fixed timeframe.
fixeddescriptionDescription of the dashboard.
experience_typeThe experience type of the dashboard.
default, product_analyticsidID of the dashboard.
is_read_onlyDEPRECATED 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]Layout type of the dashboard.
ordered, freemodified_atModification date of the dashboard.
notify_listList of handles of users to notify when changes are made to this dashboard.
reflow_typeReflow 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.
auto, fixedrestricted_rolesA list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
tabsList of tabs for organizing dashboard widgets into groups.
id [required]UUID of the tab.
name [required]Name of the tab.
widget_ids [required]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.
tagsList of team names representing ownership of a dashboard.
template_variable_presetsArray of template variables saved views.
nameThe name of the variable.
template_variablesList of variables.
nameThe name of the variable.
valueDEPRECATED (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values.
valuesOne 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_variablesList of template variables for this dashboard.
available_valuesThe list of values that the template variable drop-down is limited to.
defaultDEPRECATED (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.
defaultsOne 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]The name of the variable.
prefixThe tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
typeThe type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
title [required]Title of the dashboard.
urlThe URL of the dashboard.
widgets [required]List of widgets to display on the dashboard.
<type=alert_graph>Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.
alert_id [required]ID of the alert to use in the widget.
descriptionThe description of the widget.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleThe title of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the alert graph widget.
alert_graphalert_graphviz_type [required]Whether to display the Alert Graph as a timeseries or a top list.
timeseries, toplist<type=alert_value>Alert values are query values showing the current value of the metric in any monitor defined on your system.
alert_id [required]ID of the alert to use in the widget.
descriptionThe description of the widget.
precisionNumber of decimal to show. If not defined, will use the raw value.
text_alignHow to align the text on the widget.
center, left, righttitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of value in the widget.
type [required]Type of the alert value widget.
alert_valuealert_valueunitUnit to display with the value.
<type=bar_chart>The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]List of bar chart widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
conditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleDefine request widget style.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
styleStyle customization for a bar chart widget.
displayBar chart widget display options.
<type=stacked>Bar chart widget stacked display options.
legendBar chart widget stacked legend behavior.
automatic, inline, nonetype [required]Bar chart widget stacked display type.
stackedstacked<type=flat>Bar chart widget flat display.
type [required]Bar chart widget flat display type.
flatflatpaletteColor palette to apply to the widget.
scalingBar chart widget scaling definition.
absolute, relativetimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the bar chart widget.
bar_chartbar_chart<type=change>The Change graph shows you the change in a value over the time period chosen.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]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_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
change_typeShow the absolute or the relative change.
absolute, relativecompare_toTimeframe used for the change comparison.
hour_before, day_before, week_before, month_beforeevent_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
increase_goodWhether to show increase as good.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
order_byWhat to order by.
change, name, present, pastorder_dirWidget sorting methods.
asc, descprocess_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Query definition. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
show_presentWhether to show the present value.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the change widget.
changechange<type=check_status>Check status shows the current status or number of results for any check performed.
check [required]Name of the check to use in the widget.
descriptionThe description of the widget.
groupGroup reporting a single check.
group_byList of tag prefixes to group by in the case of a cluster check.
grouping [required]The kind of grouping to use.
check, clustertagsList of tags used to filter the groups reporting a cluster check.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the check status widget.
check_statuscheck_status<type=cohort>The cohort widget visualizes user retention over time.
descriptionThe description of the widget.
requests [required]List of Cohort widget requests.
query [required]Retention query definition.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentionfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
group_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodnameName of the query.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
request_type [required]Request type for retention grid widget.
retention_gridtimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the Cohort widget.
cohortcohort<type=distribution>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_linksA list of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
legend_sizeDEPRECATED (Deprecated) The widget legend was replaced by a tooltip and sidebar.
markersList of markers.
display_typeCombination 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.
labelLabel to display over the marker.
timeTimestamp for the widget.
value [required]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]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_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
apm_stats_queryThe APM stats query for table and distributions widgets.
columnsColumn properties used by the front end for display.
aliasA user-assigned alias for the column.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendname [required]Column name.
orderWidget sorting methods.
asc, descenv [required]Environment name.
name [required]Operation name associated with service.
primary_tag [required]The organization's host group name and value.
resourceResource name.
row_type [required]The level of detail for the request.
service, resource, spanservice [required]Service name.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
queryQuery definition for Distribution Widget Histogram Request
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdexrequest_typeDistribution of point values for distribution metrics. Renders a histogram of raw metric data points.
histogramresponse_formatDistribution of aggregated grouped queries. Use request_type instead for distribution of point values from distribution metrics.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
styleWidget style definition.
paletteColor palette to apply to the widget.
show_legendDEPRECATED (Deprecated) The widget legend was replaced by a tooltip and sidebar.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the distribution widget.
distributiondistributionxaxisX Axis controls for the distribution widget.
include_zeroTrue includes zero.
maxSpecifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
autominSpecifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.
autonum_bucketsNumber of value buckets to target, also known as the resolution of the value bins.
scaleSpecifies the scale type. Possible values are linear.
linearyaxisY Axis controls for the distribution widget.
include_zeroTrue includes zero.
labelThe label of the axis to display on the graph.
maxSpecifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
autominSpecifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
autoscaleSpecifies the scale type. Possible values are linear or log.
linear<type=embedded_app>The embedded app widget displays an App Builder app on a dashboard. Exactly one of app_id or template_id must be provided; they cannot be provided together.
app_idUUID of the App Builder app to embed.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
inputsInputs passed to the embedded app.
name [required]Name of the app input.
value [required]Value of the app input. The API accepts a string, number, boolean, object, or a non-empty homogeneous array of those types.
template_idID of the built-in app template to embed.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the embedded app widget.
embedded_appembedded_app<type=event_stream>The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.
descriptionThe description of the widget.
event_sizeSize to use to display an event.
s, lquery [required]Query to filter the event stream with.
tags_executionThe execution method for multi-value filters. Can be either and or or.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the event stream widget.
event_streamevent_stream<type=event_timeline>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.
descriptionThe description of the widget.
query [required]Query to filter the event timeline with.
tags_executionThe execution method for multi-value filters. Can be either and or or.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the event timeline widget.
event_timelineevent_timeline<type=free_text>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_colorBackground 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.
colorColor of the text.
font_sizeSize of the text.
text [required]Text to display.
text_alignHow to align the text on the widget.
center, left, righttype [required]Type of the free text widget.
free_textfree_textObject 12The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
descriptionThe description of the widget.
grouped_displayDisplay mode for grouped funnel results.
stacked, side_by_siderequests [required]Request payload used to query items.
query [required]Updated funnel widget.
data_source [required]Source from which to query items to display in the funnel.
rumrumquery_string [required]The widget query.
steps [required]List of funnel steps.
facet [required]The facet of the step.
value [required]The value of the step.
request_type [required]Widget request type.
funneltimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleThe title of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeThe size of the title.
type [required]Type of funnel widget.
funnelfunnelObject 13The user journey funnel visualization displays conversion funnels based on user journey data from Product Analytics.
descriptionThe description of the widget.
grouped_displayDisplay mode for grouped funnel results.
stacked, side_by_siderequests [required]Request payload used to query items.
comparison_segmentsComparison segments.
comparison_timeComparison time configuration for funnel widgets.
custom_timeframeCustom timeframe for funnel comparison.
from [required]Start of the custom timeframe.
to [required]End of the custom timeframe.
type [required]Type of comparison duration.
previous_timeframe, custom_timeframe, previous_day, previous_week, previous_monthquery [required]User journey funnel query definition.
computeCompute configuration for user journey funnel.
aggregation [required]Aggregation type for user journey funnel compute.
cardinality, countmetric [required]Metric for user journey funnel compute. __dd.conversion and __dd.conversion_rate accept count (unique users/sessions) and cardinality (total users/sessions) as aggregations.
__dd.conversion, __dd.conversion_ratedata_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for user journey funnel group by.
aggregation [required]Aggregation type.
metricMetric to sort by.
orderWidget sorting methods.
asc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key>subquery_idSubquery ID.
request_type [required]Request type for user journey funnel widget.
user_journey_funneltimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleThe title of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeThe size of the title.
type [required]Type of funnel widget.
funnelfunnel<type=geomap>This visualization displays a series of values by country on a world map.
custom_linksA list of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]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.
columnsWidget columns.
field [required]Widget column field.
width [required]Widget column width.
auto, compact, fullconditional_formatsThreshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED The widget metrics query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
queryUpdated list stream widget.
assignee_uuidsFilter by assignee UUIDs. Usable only with issue_stream.
clustering_pattern_field_pathSpecifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
computeCompute 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]Aggregation value.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 5 more
max, avg, earliest, latest, most_frequentfacetFacet name.
data_source [required]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.
logs_streamlogs_stream, audit_stream, ci_pipeline_stream, ci_test_stream, rum_issue_stream, apm_issue_stream, trace_stream, logs_issue_stream, logs_pattern_stream, logs_transaction_streamShow 8 more
event_stream, rum_stream, llm_observability_stream, issue_stream, security_runtime_stream, security_signals_stream, incidents_stream, case_streamevent_sizeSize to use to display an event.
s, lgroup_byGroup 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]Facet name.
indexesList of indexes.
personaPersona filter for the issue_stream data source.
all, browser, mobile, backendquery_string [required]Widget query.
sortWhich column and order to sort by
column [required]Facet path for the column
order [required]Widget sorting methods.
asc, descstatesFilter by issue states. Usable only with issue_stream.
storageOption for storage location. Feature in Private Beta.
suspected_causesFilter by suspected causes. Usable only with issue_stream.
team_handlesFilter by team handles. Usable only with issue_stream.
versionVersion 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.
sequential_queryresponse_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleThe style to apply to the request for points layer.
color_byThe category to color the points by.
text_formatsText formatting rules may be used by a points layer.
custom_bg_colorHex representation of the custom background color. Used with custom background palette option.
custom_fg_colorHex representation of the custom text color. Used with custom text palette option.
match [required]Match rule for the table widget text format.
type [required]Match or compare option.
is, is_not, contains, does_not_contain, starts_with, ends_withvalue [required]Table Widget Match String.
paletteColor-on-color palette to highlight replaced text.
white_on_greenwhite_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_bgShow 1 more
custom_textreplaceReplace rule for the table widget text format.
<type=all>Match All definition.
type [required]Table widget text format replace all type.
allwith [required]Replace All type.
<type=substring>Match Sub-string definition.
substring [required]Text that will be replaced.
type [required]Table widget text format replace sub-string type.
substringwith [required]Text that will replace original sub-string.
style [required]The style to apply to the widget.
palette [required]The color palette to apply to the widget.
palette_flip [required]Whether to flip the palette tones.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleThe title of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeThe size of the title.
type [required]Type of the geomap widget.
geomapgeomapview [required]The view of the world that the map should render.
focus [required]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).
<type=group>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_colorBackground 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_imgURL of image to display as a banner for the group.
layout_type [required]Layout type of the group.
orderedshow_titleWhether to show the title or not.
truetitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttype [required]Type of the group widget.
groupgroupwidgets [required]List of widget groups.
<type=heatgrid>The heatgrid visualization displays values for each group over time using color.
colorColor configuration for continuous gradients or discrete thresholds.
Object 1A continuous gradient with custom color stops.
mode [required]Use a continuous color gradient.
gradientsource [required]Use custom colors.
customstops [required]Two to six stops with positions in ascending order.
color [required]A color string, or two color strings for the light and dark themes, in that order.
Object 1Object 2Two color strings for the light and dark themes, in that order.
position [required]Position in the gradient, from 0 to 100.
Object 2A preset gradient color palette.
mode [required]Use a continuous color gradient.
gradientpreset_name [required]Name of the preset color palette.
source [required]Use a preset color palette.
presetObject 3Discrete thresholds with custom colors.
bins [required]Two to six bins. Omit lower_bound on the first bin. Subsequent lower bounds must be in
ascending order.
color [required]A color string, or two color strings for the light and dark themes, in that order.
Object 1Object 2Two color strings for the light and dark themes, in that order.
lower_boundInclusive lower bound. Omit for the first bin.
mode [required]Use discrete color thresholds.
discretesource [required]Use custom colors.
customObject 4A preset discrete color palette.
mode [required]Use discrete color thresholds.
discretepreset_name [required]Name of the preset color palette.
source [required]Use a preset color palette.
presetcustom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionDescription of the widget.
label_columnConfiguration of the group label column.
width [required]Width of the label column.
xs, s, m, l, xllegendLegend configuration for the heatgrid widget.
show_captionWhether to display the legend caption.
requests [required]Widget requests. The widget displays one formula, which can combine multiple queries.
formulasThe single displayed formula can combine multiple queries.
aliasExpression alias.
conditional_formatsConditional formatting rules. These rules do not affect heatgrid rendering.
Use the widget-level color configuration to control cell colors.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
queries [required]Queries returned directly or combined in a formula.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_format [required]Response format for heatgrid queries.
timeseriessort [required]Ordering of the heatgrid rows.
nesting_display [required]Display groups as flat rows.
flatsort_by [required]Sort rows by aggregated value or group label.
<property=value>Sort rows by their aggregated values.
aggregation [required]Aggregation used to order rows over the displayed time range.
avg, min, max, sumorder [required]Sort direction.
asc, descproperty [required]Sort by value.
value<property=label>Sort rows by their group labels.
order [required]Sort direction.
asc, descproperty [required]Sort by label.
labeltimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the heatgrid widget.
heatgridheatgrid<type=heatmap>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_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
eventsDEPRECATED List of widget events. Deprecated - Use overlay request type instead.
q [required]Query definition.
tags_executionThe execution method for multi-value filters.
legend_sizeAvailable legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markersList of markers.
display_typeCombination 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.
labelLabel to display over the marker.
timeTimestamp for the widget.
value [required]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]List of widget types.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
search [required]The query being made on the event.
tags_execution [required]The execution method for multi-value filters. Can be either and or or.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
queryA formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativerequest_typeApplicable only for distribution of point values for distribution metrics.
histogramresponse_formatApplicable only for distribution of aggregated grouped queries.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
styleWidget style definition.
paletteColor palette to apply to the widget.
show_legendWhether or not to display the legend on this widget.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the heat map widget.
heatmapheatmapxaxisX Axis controls for the heat map widget.
num_bucketsNumber 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).
yaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linear<type=hostmap>The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
groupDEPRECATED Deprecated - Only used by the legacy metric-based format. Use group_by (infrastructure) or a group dimension (DDSQL) inside requests instead.
no_group_hostsDEPRECATED Deprecated - Only used by the legacy metric-based format. Use no_group_hosts inside requests instead.
no_metric_hostsDEPRECATED Deprecated - Only used by the legacy metric-based format. Use no_metric_hosts inside requests instead.
node_typeDEPRECATED Deprecated - Only used by the legacy metric-based format. Use node_type inside requests instead.
host, containernotesNotes on the title.
requests [required]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).
childOptional child entities for hierarchical visualization (for example, host → container). Only used by the infrastructure-backed format.
childOptional child request for hierarchical visualization (for example, hosts containing containers). Maximum one level of nesting.
conditional_formatsList of conditional formatting rules applied to fill values.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
enrichments [required]Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
formulas [required]List of formulas that operate on queries, each assigned to a visual dimension.
aliasExpression alias.
dimension [required]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.
node, fill, size, groupformula [required]String expression built from queries, formulas, and functions.
number_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
<type=custom_unit_label>Custom unit.
unit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
queries [required]List of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
Object 2Flat group by configuration using multiple event facet fields.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsuserscompute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
targetTarget for user journey search.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
join_keysJoin keys for user journey queries.
node_objects [required]Node objects mapping.
step_aliasesStep aliases mapping.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
sourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
filtersFilters for retention queries.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
response_format [required]Response format for the scalar formula request. Only scalar is supported.
scalarfilterFilter string for the entity set in tag format (for example, env:prod).
group_byDefines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy.
column [required]Column name from the entity table (for example, cloud_provider, tags, labels).
keyKey within the column for nested attribute types (for example, service within tags).
no_group_hostsWhether to hide entities that have no group assignment.
no_metric_hostsWhether to hide entities that have no enrichment data.
node_type [required]Which type of infrastructure entity to visualize in the host map.
host, container, pod, clusterrequest_type [required]Identifies this as an infrastructure-backed host map request.
infrastructure_hostmapstyleStyle configuration for the infrastructure host map.
fill_maxMaximum value for the fill color scale. Omit to use automatic scaling.
fill_minMinimum value for the fill color scale. Omit to use automatic scaling.
paletteColor palette name or alias.
palette_flipWhether to invert the color palette.
conditional_formatsList of conditional formatting rules applied to fill values.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
enrichments [required]Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
formulas [required]List of formulas that operate on queries, each assigned to a visual dimension.
aliasExpression alias.
dimension [required]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.
node, fill, size, groupformula [required]String expression built from queries, formulas, and functions.
number_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
queries [required]List of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_format [required]Response format for the scalar formula request. Only scalar is supported.
scalarfilterFilter string for the entity set in tag format (for example, env:prod).
group_byDefines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy.
column [required]Column name from the entity table (for example, cloud_provider, tags, labels).
keyKey within the column for nested attribute types (for example, service within tags).
no_group_hostsWhether to hide entities that have no group assignment.
no_metric_hostsWhether to hide entities that have no enrichment data.
node_type [required]Which type of infrastructure entity to visualize in the host map.
host, container, pod, clusterrequest_type [required]Identifies this as an infrastructure-backed host map request.
infrastructure_hostmapstyleStyle configuration for the infrastructure host map.
fill_maxMaximum value for the fill color scale. Omit to use automatic scaling.
fill_minMinimum value for the fill color scale. Omit to use automatic scaling.
paletteColor palette name or alias.
palette_flipWhether to invert the color palette.
conditional_formatsList of conditional formatting rules applied to fill values.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
enrichmentsMetric or event queries joined to the entity set. Each formula specifies a visual dimension. Only used by the infrastructure-backed format.
formulas [required]List of formulas that operate on queries, each assigned to a visual dimension.
aliasExpression alias.
dimension [required]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.
node, fill, size, groupformula [required]String expression built from queries, formulas, and functions.
number_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
queries [required]List of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersgraph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersstring_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_format [required]Response format for the scalar formula request. Only scalar is supported.
scalarfillDEPRECATED Deprecated - Legacy metric-based format. Use the infrastructure-backed (request_type: infrastructure_hostmap) or DDSQL (request_type: data_projection) format instead.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qQuery definition.
rum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
filterFilter string for the entity set in tag format (for example, env:prod). Only used by the infrastructure-backed format.
group_byDefines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. Only used by the infrastructure-backed format.
column [required]Column name from the entity table (for example, cloud_provider, tags, labels).
keyKey within the column for nested attribute types (for example, service within tags).
limitMaximum number of rows to return from the dataset query. Only used by the DDSQL format.
no_group_hostsWhether to hide entities that have no group assignment.
no_metric_hostsWhether to hide entities that have no enrichment data.
node_typeEntity type to visualize. Only used by the infrastructure-backed format.
host, container, pod, clusterprojectionMaps dataset columns to map dimensions (entity, optional parent for grouping, fill, size). Only used by the DDSQL format.
dimensions [required]List of column-to-dimension mappings for the projection.
aliasAlias used to label the column instead of its name.
column [required]Source column name from the dataset.
dimension [required]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.
node, fill, size, groupnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
type [required]Type of the host map projection.
hostmapqueryPublished-dataset query. Only used by the DDSQL format.
data_source [required]Identifies this as a published-dataset list query.
datasetdataset_id [required]ID of the published dataset to query.
dataset_provider [required]Product page that published the dataset queried by a DatasetListQuery. ddsql_query is the only provider currently supported for host map widgets.
ddsql_queryfilterFilter applied to the dataset's rows, using events-style search syntax.
limitMaximum number of rows to return from the dataset query.
sortSort configuration for a DatasetListQuery.
fields [required]List of fields to sort the rows by, applied in order.
name [required]Name of the field to sort on.
order [required]Direction of sort.
descasc, descrequest_typeIdentifies which host map request format the sibling fields on HostMapWidgetDefinitionRequests describe: an infrastructure-backed request or a DDSQL published-dataset request.
infrastructure_hostmap, data_projectionsizeDEPRECATED Deprecated - Legacy metric-based format. Use the infrastructure-backed (request_type: infrastructure_hostmap) or DDSQL (request_type: data_projection) format instead.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qQuery definition.
rum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
styleStyle configuration for the infrastructure host map.
fill_maxMaximum value for the fill color scale. Omit to use automatic scaling.
fill_minMinimum value for the fill color scale. Omit to use automatic scaling.
paletteColor palette name or alias.
palette_flipWhether to invert the color palette.
scopeDEPRECATED Deprecated - Only used by the legacy metric-based format. Use filter inside requests instead.
styleDEPRECATED Deprecated - Only used by the legacy metric-based format. Use style inside requests instead.
fill_maxMax value to use to color the map.
fill_minMin value to use to color the map.
paletteColor palette to apply to the widget.
palette_flipWhether to flip the palette tones.
titleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the host map widget.
hostmaphostmap<type=iframe>The iframe widget allows you to embed a portion of any other web page on your dashboard.
type [required]Type of the iframe widget.
iframeiframeurl [required]URL of the iframe.
<type=image>The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
has_backgroundWhether to display a background or not.
truehas_borderWhether to display a border or not.
truehorizontal_alignHorizontal alignment.
center, left, rightmarginSize of the margins around the image.
Note: small and large values are deprecated.
sm, md, lg, small, largesizingHow 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.
fill, contain, cover, none, scale-down, zoom, fit, centertype [required]Type of the image widget.
imageimageurl [required]URL of the image.
url_dark_themeURL of the image in dark mode.
vertical_alignVertical alignment.
center, top, bottom<type=list_stream>The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.
descriptionThe description of the widget.
legend_sizeAvailable legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
requests [required]Request payload used to query items.
columns [required]Widget columns.
field [required]Widget column field.
width [required]Widget column width.
auto, compact, fullquery [required]Updated list stream widget.
assignee_uuidsFilter by assignee UUIDs. Usable only with issue_stream.
clustering_pattern_field_pathSpecifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
computeCompute 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]Aggregation value.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 5 more
max, avg, earliest, latest, most_frequentfacetFacet name.
data_source [required]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.
logs_streamlogs_stream, audit_stream, ci_pipeline_stream, ci_test_stream, rum_issue_stream, apm_issue_stream, trace_stream, logs_issue_stream, logs_pattern_stream, logs_transaction_streamShow 8 more
event_stream, rum_stream, llm_observability_stream, issue_stream, security_runtime_stream, security_signals_stream, incidents_stream, case_streamevent_sizeSize to use to display an event.
s, lgroup_byGroup 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]Facet name.
indexesList of indexes.
personaPersona filter for the issue_stream data source.
all, browser, mobile, backendquery_string [required]Widget query.
sortWhich column and order to sort by
column [required]Facet path for the column
order [required]Widget sorting methods.
asc, descstatesFilter by issue states. Usable only with issue_stream.
storageOption for storage location. Feature in Private Beta.
suspected_causesFilter by suspected causes. Usable only with issue_stream.
team_handlesFilter by team handles. Usable only with issue_stream.
versionVersion 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.
sequential_queryresponse_format [required]Widget response format.
event_listshow_legendWhether or not to display the legend on this widget.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the list stream widget.
list_streamlist_stream<type=log_stream>The Log Stream displays a log flow matching the defined query.
columnsWhich columns to display on the widget.
descriptionThe description of the widget.
indexesAn array of index names to query in the stream. Use [] to query all indexes at once.
logsetDEPRECATED ID of the log set to use.
message_displayAmount of log lines to display
inline, expanded-md, expanded-lgqueryQuery to filter the log stream with.
show_date_columnWhether to show the date column or not
show_message_columnWhether to show the message column or not
sortWhich column and order to sort by
column [required]Facet path for the column
order [required]Widget sorting methods.
asc, desctimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the log stream widget.
log_streamlog_stream<type=manage_status>The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
color_preferenceWhich color to use on the widget.
background, textcountDEPRECATED The number of monitors to display.
descriptionThe description of the widget.
display_formatWhat to display on the widget.
counts, countsAndList, listhide_zero_countsWhether to show counts of 0 or not.
query [required]Query to filter the monitors with.
show_last_triggeredWhether to show the time that has elapsed since the monitor/group triggered.
show_priorityWhether to show the priorities column.
falsesortWidget sorting methods.
name, group, status, tags, triggered, group,asc, group,desc, name,asc, name,desc, status,ascShow 7 more
status,desc, tags,asc, tags,desc, triggered,asc, triggered,desc, priority,asc, priority,descstartDEPRECATED The start of the list. Typically 0.
summary_typeWhich summary type should be used.
monitors, groups, combinedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the monitor summary widget.
manage_statusmanage_status<type=note>The notes and links widget is similar to free text widget, but allows for more formatting options.
background_colorBackground color of the note.
content [required]Content of the note.
font_sizeSize of the text.
has_paddingWhether to add padding or not.
trueshow_tickWhether to show a tick or not.
text_alignHow to align the text on the widget.
center, left, righttick_edgeDefine how you want to align the text on the widget.
bottom, left, right, toptick_posWhere to position the tick on an edge.
type [required]Type of the note widget.
notenotevertical_alignVertical alignment.
center, top, bottom<type=powerpack>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_colorBackground color of the powerpack title.
banner_imgURL of image to display as a banner for the powerpack.
powerpack_id [required]UUID of the associated powerpack.
show_titleWhether to show the title or not.
truetemplate_variablesPowerpack template variables.
controlled_by_powerpackTemplate variables controlled at the powerpack level.
name [required]The name of the variable.
prefixThe tag prefix associated with the variable.
values [required]One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified.
controlled_externallyTemplate variables controlled by the external resource, such as the dashboard this powerpack is on.
name [required]The name of the variable.
prefixThe tag prefix associated with the variable.
values [required]One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified.
titleTitle of the widget.
type [required]Type of the powerpack widget.
powerpackpowerpack<type=point_plot>The point plot displays individual data points over time.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
legendLegend configuration for the point plot widget.
type [required]Type of legend to show for the point plot widget.
automatic, nonemarkersList of markers for the widget.
display_typeCombination 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.
labelLabel to display over the marker.
timeTimestamp for the widget.
value [required]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]List of request configurations for the widget.
limitMaximum number of data points to return.
projection [required]Projection configuration for the point plot widget.
dimensions [required]List of dimension mappings for the projection.
aliasAlias for the column.
column [required]Source column name from the dataset.
dimension [required]Dimension of the point plot.
group, time, y, radiusextra_columnsAdditional columns to include in the projection.
type [required]Type of the projection.
point_plotquery [required]Query configuration for a data projection request.
data_source [required]Data source for the query.
indexesList of indexes to query.
query_string [required]The query string to filter events.
storageStorage location for the query.
request_type [required]Type of a data projection request.
data_projectiontimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the point plot widget.
point_plotpoint_plotyaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linear<type=query_value>Query values display the current value of a given metric, APM, or log query.
autoscaleWhether to use auto-scaling or not.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
custom_unitDisplay a unit of your choice on the widget.
descriptionThe description of the widget.
precisionNumber of decimals to show. If not defined, the widget uses the raw value.
requests [required]Widget definition.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentileapm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
comparisonDisplays a change indicator showing a delta against a historical baseline.
directionalityWhich direction of change is considered an improvement, determining the indicator color.
neutralincrease_better, decrease_better, neutralduration [required]The comparison period. Use a preset type value or set type to custom_timeframe and provide custom_timeframe with explicit millisecond epoch bounds.
custom_timeframeRequired when type is custom_timeframe. Fixed time range to compare against.
from [required]Start time in milliseconds since epoch.
to [required]End time in milliseconds since epoch.
type [required]The comparison window type.
previous_timeframe, custom_timeframe, previous_day, previous_week, previous_monthtypeHow the delta is expressed: absolute (raw difference), relative (percentage), or both.
absoluteabsolute, relative, bothconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
text_alignHow to align the text on the widget.
center, left, righttimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtimeseries_backgroundSet a timeseries on the widget background.
type [required]Timeseries is made using an area or bars.
areabars, areayaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
lineartitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the query value widget.
query_valuequery_value<type=retention_curve>The retention curve widget visualizes user retention rates over time.
descriptionThe description of the widget.
requests [required]List of Retention Curve widget requests.
query [required]Retention query definition.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentionfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
group_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodnameName of the query.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
request_type [required]Request type for retention curve widget.
retention_curvestyleStyle configuration for retention curve.
paletteColor palette for the retention curve.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the Retention Curve widget.
retention_curveretention_curve<type=run_workflow>Run workflow is widget that allows you to run a workflow from a dashboard.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
inputsArray of workflow inputs to map to dashboard template variables.
name [required]Name of the workflow input.
value [required]Dashboard template variable. Can be suffixed with '.value' or '.key'.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the run workflow widget.
run_workflowrun_workflowworkflow_id [required]Workflow id.
<type=slo_list>Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
descriptionThe description of the widget.
requests [required]Array of one request object to display in the widget.
query [required]Updated SLO List widget.
limitMaximum number of results to display in the table.
100query_string [required]Widget query.
sortOptions for sorting results.
column [required]Facet path for the column
order [required]Widget sorting methods.
asc, descrequest_type [required]Widget request type.
slo_listtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the SLO List widget.
slo_listslo_list<type=slo>Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
additional_query_filtersAdditional filters applied to the SLO query.
descriptionThe description of the widget.
global_time_targetDefined global time target.
show_error_budgetDefined error budget.
slo_idID of the SLO displayed.
time_windowsTimes being monitored.
titleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the SLO widget.
slosloview_modeDefine how you want the SLO to be displayed.
overall, component, bothview_type [required]Type of view displayed by the widget.
detail<type=scatterplot>The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groupsList of groups used for colors.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]Widget definition.
tableScatterplot request containing formulas and functions.
formulasList of Scatterplot formulas that operate on queries.
aliasExpression alias.
dimension [required]Dimension of the Scatterplot.
x, y, radius, colorformula [required]String expression built from queries, formulas, and functions.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersgraph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersstring_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listxUpdated scatter plot.
aggregatorAggregator used for the request.
avg, last, max, min, sumapm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qQuery definition.
rum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
yUpdated scatter plot.
aggregatorAggregator used for the request.
avg, last, max, min, sumapm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qQuery definition.
rum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the scatter plot widget.
scatterplotscatterplotxaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linearyaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linear<type=sankey>The Sankey diagram visualizes the flow of data between categories, stages or sets of values.
requests [required]List of Sankey widget requests.
<request_type=sankey>Sankey widget request for Product Analytics or RUM data source.
query [required]Query configuration for Product Analytics or RUM Sankey widget.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
data_source [required]Product Analytics or RUM data source type.
product_analyticsrum, product_analyticsentries_per_stepEntries per step.
join_keysJoin keys.
primary [required]Primary join key.
secondarySecondary join keys.
mode [required]Sankey mode for Product Analytics or RUM queries.
sourcesource, targetnumber_of_stepsNumber of steps.
occurrencesFilter applied to occurrence counts when building a Product Analytics audience.
operatorThe comparison operator used for the occurrence filter (for example: gt, lt, eq).
valueThe threshold value to compare occurrence counts against.
query_string [required]RUM event search query used to filter views or actions.
sourceSource.
subquery_idSubquery ID.
targetTarget.
request_type [required]Type of the Sankey widget.
sankeysankey<request_type=netflow_sankey>Sankey widget request for network data source.
query [required]Query configuration for Sankey network widget.
computeCompute aggregation for network queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric to aggregate.
data_source [required]Network data source type.
networknetwork_device_flows, networkgroup_by [required]Fields to group by.
limit [required]Maximum number of results.
modeSankey mode for network queries.
targettargetquery_string [required]Query string for filtering network data.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for network queries.
fieldField to sort by.
orderWidget sorting methods.
asc, descrequest_type [required]Type of request for network Sankey widget.
netflow_sankeynetflow_sankeyshow_other_linksWhether to show links for "other" category.
sort_nodesWhether to sort nodes in the Sankey diagram.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the Sankey widget.
sankeysankey<type=servicemap>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_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
filters [required]Your environment and primary tag (or * if enabled for your account).
service [required]The ID of the service you want to map.
titleThe title of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the service map widget.
servicemapservicemap<type=trace_service>The service summary displays the graphs of a chosen service in your dashboard.
descriptionThe description of the widget.
display_formatNumber of columns to display.
one_column, two_column, three_columnenv [required]APM environment.
service [required]APM service.
show_breakdownWhether to show the latency breakdown or not.
show_distributionWhether to show the latency distribution or not.
show_errorsWhether to show the error metrics or not.
show_hitsWhether to show the hits metrics or not.
show_latencyWhether to show the latency metrics or not.
show_resource_listWhether to show the resource list or not.
size_formatSize of the widget.
small, medium, largespan_name [required]APM span name.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the service summary widget.
trace_servicetrace_service<type=split_group>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_axesNormalize y axes across graphs
size [required]Size of the individual graphs in the split.
xs, sm, md, lgsource_widget_definition [required]The original widget we are splitting on.
<type=bar_chart>The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]List of bar chart widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
conditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleDefine request widget style.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
styleStyle customization for a bar chart widget.
displayBar chart widget display options.
<type=stacked>Bar chart widget stacked display options.
legendBar chart widget stacked legend behavior.
automatic, inline, nonetype [required]Bar chart widget stacked display type.
stackedstacked<type=flat>Bar chart widget flat display.
type [required]Bar chart widget flat display type.
flatflatpaletteColor palette to apply to the widget.
scalingBar chart widget scaling definition.
absolute, relativetimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the bar chart widget.
bar_chartbar_chart<type=change>The Change graph shows you the change in a value over the time period chosen.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]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_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
change_typeShow the absolute or the relative change.
absolute, relativecompare_toTimeframe used for the change comparison.
hour_before, day_before, week_before, month_beforeevent_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
increase_goodWhether to show increase as good.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
order_byWhat to order by.
change, name, present, pastorder_dirWidget sorting methods.
asc, descprocess_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Query definition. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
show_presentWhether to show the present value.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the change widget.
changechange<type=geomap>This visualization displays a series of values by country on a world map.
custom_linksA list of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]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.
columnsWidget columns.
field [required]Widget column field.
width [required]Widget column width.
auto, compact, fullconditional_formatsThreshold (numeric) conditional formatting rules may be used by a regions layer.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED The widget metrics query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
queryUpdated list stream widget.
assignee_uuidsFilter by assignee UUIDs. Usable only with issue_stream.
clustering_pattern_field_pathSpecifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
computeCompute 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]Aggregation value.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 5 more
max, avg, earliest, latest, most_frequentfacetFacet name.
data_source [required]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.
logs_streamlogs_stream, audit_stream, ci_pipeline_stream, ci_test_stream, rum_issue_stream, apm_issue_stream, trace_stream, logs_issue_stream, logs_pattern_stream, logs_transaction_streamShow 8 more
event_stream, rum_stream, llm_observability_stream, issue_stream, security_runtime_stream, security_signals_stream, incidents_stream, case_streamevent_sizeSize to use to display an event.
s, lgroup_byGroup 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]Facet name.
indexesList of indexes.
personaPersona filter for the issue_stream data source.
all, browser, mobile, backendquery_string [required]Widget query.
sortWhich column and order to sort by
column [required]Facet path for the column
order [required]Widget sorting methods.
asc, descstatesFilter by issue states. Usable only with issue_stream.
storageOption for storage location. Feature in Private Beta.
suspected_causesFilter by suspected causes. Usable only with issue_stream.
team_handlesFilter by team handles. Usable only with issue_stream.
versionVersion 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.
sequential_queryresponse_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleThe style to apply to the request for points layer.
color_byThe category to color the points by.
text_formatsText formatting rules may be used by a points layer.
custom_bg_colorHex representation of the custom background color. Used with custom background palette option.
custom_fg_colorHex representation of the custom text color. Used with custom text palette option.
match [required]Match rule for the table widget text format.
type [required]Match or compare option.
is, is_not, contains, does_not_contain, starts_with, ends_withvalue [required]Table Widget Match String.
paletteColor-on-color palette to highlight replaced text.
white_on_greenwhite_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_bgShow 1 more
custom_textreplaceReplace rule for the table widget text format.
<type=all>Match All definition.
type [required]Table widget text format replace all type.
allwith [required]Replace All type.
<type=substring>Match Sub-string definition.
substring [required]Text that will be replaced.
type [required]Table widget text format replace sub-string type.
substringwith [required]Text that will replace original sub-string.
style [required]The style to apply to the widget.
palette [required]The color palette to apply to the widget.
palette_flip [required]Whether to flip the palette tones.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleThe title of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeThe size of the title.
type [required]Type of the geomap widget.
geomapgeomapview [required]The view of the world that the map should render.
focus [required]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).
<type=query_value>Query values display the current value of a given metric, APM, or log query.
autoscaleWhether to use auto-scaling or not.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
custom_unitDisplay a unit of your choice on the widget.
descriptionThe description of the widget.
precisionNumber of decimals to show. If not defined, the widget uses the raw value.
requests [required]Widget definition.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentileapm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
comparisonDisplays a change indicator showing a delta against a historical baseline.
directionalityWhich direction of change is considered an improvement, determining the indicator color.
neutralincrease_better, decrease_better, neutralduration [required]The comparison period. Use a preset type value or set type to custom_timeframe and provide custom_timeframe with explicit millisecond epoch bounds.
custom_timeframeRequired when type is custom_timeframe. Fixed time range to compare against.
from [required]Start time in milliseconds since epoch.
to [required]End time in milliseconds since epoch.
type [required]The comparison window type.
previous_timeframe, custom_timeframe, previous_day, previous_week, previous_monthtypeHow the delta is expressed: absolute (raw difference), relative (percentage), or both.
absoluteabsolute, relative, bothconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
text_alignHow to align the text on the widget.
center, left, righttimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtimeseries_backgroundSet a timeseries on the widget background.
type [required]Timeseries is made using an area or bars.
areabars, areayaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
lineartitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the query value widget.
query_valuequery_value<type=scatterplot>The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groupsList of groups used for colors.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]Widget definition.
tableScatterplot request containing formulas and functions.
formulasList of Scatterplot formulas that operate on queries.
aliasExpression alias.
dimension [required]Dimension of the Scatterplot.
x, y, radius, colorformula [required]String expression built from queries, formulas, and functions.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
Object 2Flat group by configuration using multiple event facet fields.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsuserscompute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
targetTarget for user journey search.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
join_keysJoin keys for user journey queries.
node_objects [required]Node objects mapping.
step_aliasesStep aliases mapping.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
sourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
filtersFilters for retention queries.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listxUpdated scatter plot.
aggregatorAggregator used for the request.
avg, last, max, min, sumapm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qQuery definition.
rum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
yUpdated scatter plot.
aggregatorAggregator used for the request.
avg, last, max, min, sumapm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qQuery definition.
rum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the scatter plot widget.
scatterplotscatterplotxaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linearyaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linear<type=sunburst>Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
hide_totalShow the total value in this widget.
legendConfiguration of the legend.
Object 1Configuration of table-based legend.
type [required]Whether or not to show a table legend.
table, noneObject 2Configuration of inline or automatic legends.
hide_percentWhether to hide the percentages of the groups.
hide_valueWhether to hide the values of the groups.
type [required]Whether to show the legend inline or let it be automatically generated.
inline, automaticrequests [required]List of sunburst widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleWidget style definition.
paletteColor palette to apply to the widget.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the Sunburst widget.
sunburstsunburst<type=query_table>The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
has_search_barControls the display of the search bar.
always, never, autorequests [required]Widget definition.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilealiasThe column name (defaults to the metric name).
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
apm_stats_queryThe APM stats query for table and distributions widgets.
columnsColumn properties used by the front end for display.
aliasA user-assigned alias for the column.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendname [required]Column name.
orderWidget sorting methods.
asc, descenv [required]Environment name.
name [required]Operation name associated with service.
primary_tag [required]The organization's host group name and value.
resourceResource name.
row_type [required]The level of detail for the request.
service, resource, spanservice [required]Service name.
cell_display_modeA list of display modes for each table cell.
conditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
limitFor metric queries, the number of lines to show in the table. Only one request should have this property.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
orderWidget sorting methods.
asc, descprocess_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Query definition. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
grouptext_formatsList of text formats for columns produced by tags.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the table widget.
query_tablequery_table<type=timeseries>The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
eventsDEPRECATED List of widget events. Deprecated - Use overlay request type instead.
q [required]Query definition.
tags_executionThe execution method for multi-value filters.
legend_columnsColumns displayed in the legend.
legend_layoutLayout of the legend.
auto, horizontal, verticallegend_sizeAvailable legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markersList of markers.
display_typeCombination 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.
labelLabel to display over the marker.
timeTimestamp for the widget.
value [required]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]List of timeseries widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
display_typeType of display to use for the request.
area, bars, line, overlayevent_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
metadataUsed to define expression aliases.
alias_nameExpression alias.
expression [required]Expression name.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
on_right_yaxisWhether or not to display a second y-axis on the right.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
styleDefine request widget style for timeseries widgets.
has_value_labelsIf true, the value is displayed as a label relative to the data point.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
right_yaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linearshow_legend(screenboard only) Show the legend for this widget.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the timeseries widget.
timeseriestimeseriesyaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linear<type=toplist>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_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]List of top list widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
conditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleDefine request widget style.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
styleStyle customization for a top list widget.
displayTop list widget display options.
<type=stacked>Top list widget stacked display options.
legendTop list widget stacked legend behavior.
automatic, inline, nonetype [required]Top list widget stacked display type.
stackedstacked<type=flat>Top list widget flat display.
type [required]Top list widget flat display type.
flatflatpaletteColor palette to apply to the widget.
scalingTop list widget scaling definition.
absolute, relativetimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the top list widget.
toplisttoplist<type=treemap>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_byDEPRECATED (deprecated) The attribute formerly used to determine color in the widget.
userusercustom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
group_byDEPRECATED (deprecated) The attribute formerly used to group elements in the widget.
user, family, processrequests [required]List of treemap widget requests.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
qDEPRECATED The widget metrics query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
Object 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
indexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
graph_filtersGraph filters.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_interval [required]Time interval for cohort criteria.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
time_intervalTime interval for return criteria.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listsortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleDefine request widget style.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
size_byDEPRECATED (deprecated) The attribute formerly used to determine size in the widget.
pct_cpu, pct_memtimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
type [required]Type of the treemap widget.
treemaptreemapsplit_config [required]Encapsulates all user choices about how to split a graph.
limit [required]Maximum number of graphs to display in the widget.
sort [required]Controls the order in which graphs appear in the split.
computeDefines the metric and aggregation used as the sort value.
aggregation [required]How to aggregate the sort metric for the purposes of ordering.
metric [required]The metric to use for sorting graphs.
order [required]Widget sorting methods.
asc, descsplit_dimensions [required]The dimension(s) on which to split the graph
one_graph_per [required]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_splitsManual selection of tags making split graph widget static
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
type [required]Type of the split graph widget
split_groupsplit_group<type=sunburst>Sunbursts are spot on to highlight how groups contribute to the total of a query.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
hide_totalShow the total value in this widget.
legendConfiguration of the legend.
Object 1Configuration of table-based legend.
type [required]Whether or not to show a table legend.
table, noneObject 2Configuration of inline or automatic legends.
hide_percentWhether to hide the percentages of the groups.
hide_valueWhether to hide the values of the groups.
type [required]Whether to show the legend inline or let it be automatically generated.
inline, automaticrequests [required]List of sunburst widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleWidget style definition.
paletteColor palette to apply to the widget.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the Sunburst widget.
sunburstsunburst<type=query_table>The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
has_search_barControls the display of the search bar.
always, never, autorequests [required]Widget definition.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilealiasThe column name (defaults to the metric name).
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
apm_stats_queryThe APM stats query for table and distributions widgets.
columnsColumn properties used by the front end for display.
aliasA user-assigned alias for the column.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendname [required]Column name.
orderWidget sorting methods.
asc, descenv [required]Environment name.
name [required]Operation name associated with service.
primary_tag [required]The organization's host group name and value.
resourceResource name.
row_type [required]The level of detail for the request.
service, resource, spanservice [required]Service name.
cell_display_modeA list of display modes for each table cell.
conditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
limitFor metric queries, the number of lines to show in the table. Only one request should have this property.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
orderWidget sorting methods.
asc, descprocess_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Query definition. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
grouptext_formatsList of text formats for columns produced by tags.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the table widget.
query_tablequery_table<type=timeseries>The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
eventsDEPRECATED List of widget events. Deprecated - Use overlay request type instead.
q [required]Query definition.
tags_executionThe execution method for multi-value filters.
legend_columnsColumns displayed in the legend.
legend_layoutLayout of the legend.
auto, horizontal, verticallegend_sizeAvailable legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
markersList of markers.
display_typeCombination 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.
labelLabel to display over the marker.
timeTimestamp for the widget.
value [required]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]List of timeseries widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
display_typeType of display to use for the request.
area, bars, line, overlayevent_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
metadataUsed to define expression aliases.
alias_nameExpression alias.
expression [required]Expression name.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
on_right_yaxisWhether or not to display a second y-axis on the right.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
styleDefine request widget style for timeseries widgets.
has_value_labelsIf true, the value is displayed as a label relative to the data point.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
right_yaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linearshow_legend(screenboard only) Show the legend for this widget.
timeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the timeseries widget.
timeseriestimeseriesyaxisAxis controls for the widget.
include_zeroSet to true to include zero.
labelThe label of the axis to display on the graph. Only usable on Scatterplot Widgets.
maxSpecifies maximum numeric value to show on the axis. Defaults to auto.
autominSpecifies minimum numeric value to show on the axis. Defaults to auto.
autoscaleSpecifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
linear<type=toplist>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_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]List of top list widget requests.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
conditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
sortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleDefine request widget style.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
styleStyle customization for a top list widget.
displayTop list widget display options.
<type=stacked>Top list widget stacked display options.
legendTop list widget stacked legend behavior.
automatic, inline, nonetype [required]Top list widget stacked display type.
stackedstacked<type=flat>Top list widget flat display.
type [required]Top list widget flat display type.
flatflatpaletteColor palette to apply to the widget.
scalingTop list widget scaling definition.
absolute, relativetimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the top list widget.
toplisttoplistObject 41This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
Object 1Topology map widget backed by the data streams data source.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]One Topology request.
queryQuery to the data streams topology data source.
data_source [required]Name of the data source.
data_streamsfilters [required]Your environment and primary tag (or * if enabled for your account).
query_stringA search string for filtering services. When set, this replaces the service field.
service [required](deprecated) Name of the service. Leave this empty and use query_string instead.
request_typeWidget request type.
topologytimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the topology map widget.
topology_maptopology_mapObject 2Topology map widget backed by the service map data source.
custom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
requests [required]One Topology request.
queryQuery to the service map topology data source.
data_source [required]Name of the data source.
service_mapfilters [required]Your environment and primary tag (or * if enabled for your account).
query_stringA search string for filtering services. When set, this replaces the service field.
service [required](deprecated) Name of the service. Leave this empty and use query_string instead.
request_typeWidget request type.
topologytimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the topology map widget.
topology_maptopology_map<type=treemap>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_byDEPRECATED (deprecated) The attribute formerly used to determine color in the widget.
userusercustom_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
descriptionThe description of the widget.
group_byDEPRECATED (deprecated) The attribute formerly used to group elements in the widget.
user, family, processrequests [required]List of treemap widget requests.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
qDEPRECATED The widget metrics query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
graph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourfiltersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
string_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listsortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleDefine request widget style.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
size_byDEPRECATED (deprecated) The attribute formerly used to determine size in the widget.
pct_cpu, pct_memtimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of your widget.
type [required]Type of the treemap widget.
treemaptreemap<type=wildcard>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_linksList of custom links.
is_hiddenThe flag for toggling context menu link visibility.
labelThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
linkThe URL of the custom link. URL must include http or https. A relative URL must start with /.
override_labelThe label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
requests [required]List of data requests for the wildcard widget.
Object 1An updated treemap widget.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
qDEPRECATED The widget metrics query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersgraph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersstring_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listsortThe controls for sorting the widget.
countThe number of items to limit the widget to.
order_byThe array of items to sort the widget by in order.
<type=formula>The formula to sort the widget by.
index [required]The index of the formula to sort by.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to formula.
formula<type=group>The group to sort the widget by.
name [required]The name of the group.
order [required]Widget sorting methods.
asc, desctype [required]Set the sort type to group.
groupstyleDefine request widget style.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
Object 2Updated timeseries widget.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
audit_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
display_typeType of display to use for the request.
area, bars, line, overlayevent_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
metadataUsed to define expression aliases.
alias_nameExpression alias.
expression [required]Expression name.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
on_right_yaxisWhether or not to display a second y-axis on the right.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersgraph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersstring_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
response_formatTimeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
styleDefine request widget style for timeseries widgets.
has_value_labelsIf true, the value is displayed as a label relative to the data point.
line_typeType of lines displayed.
dashed, dotted, solidline_widthWidth of line displayed.
normal, thick, thinorder_byHow 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)
tags, valuespaletteColor palette to apply to the widget.
Object 3Updated list stream widget.
columns [required]Widget columns.
field [required]Widget column field.
width [required]Widget column width.
auto, compact, fullquery [required]Updated list stream widget.
assignee_uuidsFilter by assignee UUIDs. Usable only with issue_stream.
clustering_pattern_field_pathSpecifies the field for logs pattern clustering. Usable only with logs_pattern_stream.
computeCompute 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]Aggregation value.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 5 more
max, avg, earliest, latest, most_frequentfacetFacet name.
data_source [required]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.
logs_streamlogs_stream, audit_stream, ci_pipeline_stream, ci_test_stream, rum_issue_stream, apm_issue_stream, trace_stream, logs_issue_stream, logs_pattern_stream, logs_transaction_streamShow 8 more
event_stream, rum_stream, llm_observability_stream, issue_stream, security_runtime_stream, security_signals_stream, incidents_stream, case_streamevent_sizeSize to use to display an event.
s, lgroup_byGroup 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]Facet name.
indexesList of indexes.
personaPersona filter for the issue_stream data source.
all, browser, mobile, backendquery_string [required]Widget query.
sortWhich column and order to sort by
column [required]Facet path for the column
order [required]Widget sorting methods.
asc, descstatesFilter by issue states. Usable only with issue_stream.
storageOption for storage location. Feature in Private Beta.
suspected_causesFilter by suspected causes. Usable only with issue_stream.
team_handlesFilter by team handles. Usable only with issue_stream.
versionVersion 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.
sequential_queryresponse_format [required]Widget response format.
event_listObject 4Updated distribution widget.
apm_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
apm_stats_queryThe APM stats query for table and distributions widgets.
columnsColumn properties used by the front end for display.
aliasA user-assigned alias for the column.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendname [required]Column name.
orderWidget sorting methods.
asc, descenv [required]Environment name.
name [required]Operation name associated with service.
primary_tag [required]The organization's host group name and value.
resourceResource name.
row_type [required]The level of detail for the request.
service, resource, spanservice [required]Service name.
event_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
formulasList of formulas that operate on queries.
aliasExpression alias.
cell_display_modeDefine a display mode for the table cell.
number, bar, trendcell_display_mode_optionsCell display mode options for the widget formula. (only if cell_display_mode is set to trend).
trend_typeTrend type for the cell display mode options.
area, line, barsy_scaleY scale for the cell display mode options.
shared, independentconditional_formatsList of conditional formats.
comparator [required]Comparator to apply.
=, >, >=, <, <=custom_bg_colorColor palette to apply to the background, same values available as palette.
custom_fg_colorColor palette to apply to the foreground, same values available as palette.
hide_valueTrue hides values.
image_urlDisplays an image as the background.
metricMetric from the request to correlate this conditional format with.
palette [required]Color palette to apply.
blue, custom_bg, custom_image, custom_text, gray_on_white, grey, green, orange, red, red_on_whiteShow 9 more
white_on_gray, white_on_green, green_on_white, white_on_red, white_on_yellow, yellow_on_white, black_on_light_yellow, black_on_light_green, black_on_light_redtimeframeDefines the displayed timeframe.
value [required]Value for the comparator.
formula [required]String expression built from queries, formulas, and functions.
limitOptions for limiting results returned.
countNumber of results to return.
orderDirection of sort.
descasc, descnumber_formatNumber format options for the widget.
unitNumber format unit.
<type=canonical_unit>Canonical unit.
per_unit_nameThe name of the unit per item.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
<type=custom_unit_label>Custom unit.
labelThe label for the custom unit.
typeThe type of custom unit.
custom_unit_labelunit_scaleThe definition of NumberFormatUnitScale object.
typeThe type of unit scale.
canonical_unitunit_nameThe name of the unit.
styleStyling options for widget formulas.
paletteThe 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_indexIndex specifying which color to use within the palette.
log_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
network_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
process_queryDEPRECATED Deprecated - Use queries and formulas instead.
filter_byList of processes.
limitMax number of items in the filter list.
metric [required]Your chosen metric.
search_byYour chosen search term.
profile_metrics_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
qDEPRECATED Widget query. Deprecated - Use queries and formulas instead.
queriesList of queries that can be returned directly or used in formulas.
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
Object 3Process query using formulas and functions.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data sources that rely on the process backend.
process, containeris_normalized_cpuWhether to normalize the CPU percentages.
limitNumber of hits to return.
metric [required]Process metric name.
name [required]Name of query for use in formulas.
sortDirection of sort.
descasc, desctag_filtersAn array of tags to filter by.
text_filterText to use as filter.
<data_source=apm_dependency_stats>A formula and functions APM dependency stats query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM dependency stats queries.
apm_dependency_statsenv [required]APM environment.
is_upstreamDetermines whether stats for upstream or downstream dependencies should be queried.
name [required]Name of query to use in formulas.
operation_name [required]Name of operation on service.
primary_tag_nameThe name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_valueFilter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]APM resource.
service [required]APM service.
stat [required]APM statistic.
avg_duration, avg_root_duration, avg_spans_per_trace, error_rate, pct_exec_time, pct_of_traces, total_traces_count<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdex<data_source=slo>A formula and functions metrics query.
additional_query_filtersAdditional filters applied to the SLO query.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for SLO measures queries.
slogroup_modeGroup mode to query measures.
overall, componentsmeasure [required]SLO measures queries.
good_events, bad_events, good_minutes, bad_minutes, slo_status, error_budget_remaining, burn_rate, error_budget_burndownnameName of the query for use in formulas.
slo_id [required]ID of an SLO to query measures.
slo_query_typeName of the query for use in formulas.
metric, monitor, time_slice<data_source=cloud_cost>A formula and functions Cloud Cost query.
aggregatorAggregator used for the request.
avg, last, max, min, sum, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for Cloud Cost queries.
cloud_costname [required]Name of the query for use in formulas.
query [required]Query for Cloud Cost data.
<data_source=product_analytics_extended>A formula and functions Product Analytics Extended query for advanced analytics features.
audience_filtersProduct Analytics/RUM audience filters.
accountsnameThe name of the account subquery.
queryThe query string for the account subquery.
filter_conditionAn optional filter condition applied to the audience subquery.
segmentsnameThe name of the segment subquery.
segment_idThe unique identifier of the segment.
usersnameThe name of the user subquery.
queryThe query string for the user subquery.
compute [required]Compute configuration for Product Analytics Extended queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with rollup.
metricMeasurable attribute to compute.
nameName of the compute for use in formulas.
rollupCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with interval.
alignmentAlignment 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).
quantityQuantity of the interval.
timezoneTimezone for the interval.
type [required]Type of calendar interval.
day, week, month, year, quarter, minute, hourdata_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
query [required]RUM event search query used to filter views or actions.
<data_source=product_analytics_journey>A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
compute [required]Compute configuration for User Journey formula queries.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalTime bucket interval in milliseconds for time series queries.
metricMetric 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.
__dd.conversion, __dd.conversion_rate, __dd.time_to_converttargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
facet [required]Facet name to group by.
limitMaximum number of groups to return.
should_exclude_missingWhether to exclude events missing the group-by facet.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, desctargetTarget for user journey search.
endEnd value.
startStart value.
type [required]Target type.
valueTarget value.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
expression [required]Expression string.
filtersFilters for user journey search.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersgraph_filtersGraph filters.
nameFilter name.
operatorFilter operator.
targetTarget for user journey search.
valueFilter value.
string_filterString filter.
join_keysJoin keys for user journey queries.
primary [required]Primary join key.
secondarySecondary join keys.
node_objects [required]Node objects mapping.
<any-key>Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
step_aliasesStep aliases mapping.
<any-key><data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
aggregation [required]The type of aggregation that can be performed on events-based queries.
Object 1Standard aggregation types for events-based queries.
avg, cardinality, count, delta, earliest, latest, max, median, min, most_frequentShow 1 more
sumObject 2Percentile aggregation.
metric [required]Metric for retention compute.
__dd.retention, __dd.retention_ratedata_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
facet [required]Facet to group by.
limitMaximum number of groups.
should_exclude_missingWhether to exclude missing values.
sortSort configuration for retention group by.
orderWidget sorting methods.
asc, descsourceSource field.
target [required]Target for retention group by.
cohort, return_periodname [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
cohort_criteria [required]Cohort criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_interval [required]Time interval for cohort criteria.
type [required]Type of time interval for cohort criteria.
calendarvalue [required]Calendar interval definition.
filtersFilters for retention queries.
audience_filtersProduct Analytics/RUM audience filters.
accountsfilter_conditionAn optional filter condition applied to the audience subquery.
segmentsusersstring_filterString filter.
retention_entity [required]Entity to track for retention.
@usr.id, @account.idreturn_condition [required]Condition for counting user return.
conversion_on, conversion_on_or_afterreturn_criteriaReturn criteria for retention queries.
base_query [required]Base query for Product Analytics.
data_source [required]Data source for Product Analytics event queries.
product_analyticssearch [required]Search configuration for Product Analytics event query.
time_intervalTime interval for return criteria.
type [required]Type of time interval for return criteria.
fixedunit [required]Unit of time for retention return criteria interval.
day, week, monthvalue [required]Value of the time interval.
queryQuery definition for Distribution Widget Histogram Request
<data_source=metrics>A formula and functions metrics query.
aggregatorThe aggregation methods available for metrics queries.
avg, min, max, sum, last, area, l2norm, percentilecross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for metrics queries.
metricsname [required]Name of the query for use in formulas.
query [required]Metrics query definition.
semantic_modeSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed.
combined, nativeObject 2A formula and functions events query.
compute [required]Compute options.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgintervalA time interval in milliseconds.
metricMeasurable attribute to compute.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for event platform-based queries.
logs, spans, network, network_device_flows, rum, security_signals, profiles, audit, events, ci_testsShow 6 more
ci_pipelines, incident_analytics, product_analytics, on_call_events, errors, llm_observabilitygroup_byGroup 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.
Object 1List of objects used to group by.
facet [required]Event facet.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descObject 2Flat group by configuration using multiple event facet fields.
fields [required]List of event facets to group by.
limitNumber of groups to return.
sortOptions for sorting group by results.
aggregation [required]Aggregation methods for event platform queries.
count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, minShow 2 more
max, avgmetricMetric used for sorting group by results.
orderDirection of sort.
descasc, descindexesAn array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]Name of the query for use in formulas.
searchSearch options.
query [required]Events search string.
storageOption for storage location. Feature in Private Beta.
<data_source=apm_resource_stats>DEPRECATED APM resource stats query using formulas and functions. Deprecated - Use apm_metrics query type instead.
cross_org_uuidsThe source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]Data source for APM resource stats queries.
apm_resource_statsenv [required]APM environment.
group_byArray of fields to group results by.
name [required]Name of this query to use in formulas.
operation_nameName of operation on service.
primary_tag_nameName of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_valueValue of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_nameAPM resource name.
service [required]APM service name.
stat [required]APM resource stat name.
errors, error_rate, hits, latency_avg, latency_distribution, latency_max, latency_p50, latency_p75, latency_p90, latency_p95Show 1 more
latency_p99<data_source=apm_metrics>A formula and functions APM metrics query.
data_source [required]Data source for APM metrics queries.
apm_metricsgroup_byOptional fields to group the query results by.
name [required]Name of this query to use in formulas.
operation_modeOptional operation mode to aggregate across operation names.
operation_nameName of operation on service. If not provided, the primary operation name is used.
peer_tagsTags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
query_filterAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).
resource_hashThe hash of a specific resource to filter by.
resource_nameThe full name of a specific resource to filter by.
serviceAPM service name.
span_kindDescribes the relationship between the span, its parents, and its children in a trace.
consumer, server, client, producer, internalstat [required]APM metric stat name.
errors, error_rate, errors_per_second, latency_avg, latency_max, latency_p50, latency_p75, latency_p90, latency_p95, latency_p99Show 6 more
latency_p999, latency_distribution, hits, hits_per_second, total_time, apdexrequest_typeDistribution of point values for distribution metrics. Renders a histogram of raw metric data points.
histogramresponse_formatDistribution of aggregated grouped queries. Use request_type instead for distribution of point values from distribution metrics.
timeseries, scalar, event_listrum_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
security_queryDEPRECATED Deprecated - Use queries and formulas instead.
computeDefine computation for a log query.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
group_byList of tag prefixes to group by in the case of a cluster check.
facet [required]Facet name.
limitMaximum number of items in the group.
sortDefine a sorting method.
aggregation [required]The aggregation method.
facetFacet name.
order [required]Widget sorting methods.
asc, descindexA coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_computeThis field is mutually exclusive with compute.
aggregation [required]The aggregation method.
facetFacet name.
intervalDefine a time interval in seconds.
searchThe query being made on the logs.
query [required]Search value to apply.
styleWidget style definition.
paletteColor palette to apply to the widget.
specification [required]Vega or Vega-Lite specification for custom visualization rendering. See https://vega.github.io/vega-lite/ for the full grammar reference.
contents [required]The Vega or Vega-Lite JSON specification object.
type [required]Type of specification used by the wildcard widget.
vega, vega-litetimeTime setting for the widget.
Object 1Wrapper for live span
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
live_spanThe available timeframes depend on the widget you are using.
1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d, 2d, 1wShow 7 more
1mo, 3mo, 6mo, week_to_date, month_to_date, 1y, alert<type=live>Used for arbitrary live span times, such as 17 minutes or 6 hours.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
type [required]Type "live" denotes a live span in the new format.
liveunit [required]Unit of the time span.
minute, hour, day, week, month, yearvalue [required]Value of the time span.
<type=fixed>Used for fixed span times, such as 'March 1 to March 7'.
from [required]Start time in milliseconds since epoch.
hide_incomplete_cost_dataWhether to hide incomplete cost data in the widget.
to [required]End time in milliseconds since epoch.
type [required]Type "fixed" denotes a fixed span.
fixedtitleTitle of the widget.
title_alignHow to align the text on the widget.
center, left, righttitle_sizeSize of the title.
type [required]Type of the wildcard widget.
wildcardwildcardidID of the widget.
layoutThe layout for a widget on a free or new dashboard layout dashboard.
height [required]The height of the widget. Should be a non-negative integer.
is_column_breakWhether 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]The width of the widget. Should be a non-negative integer.
x [required]The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]The position of the widget on the y (vertical) axis. Should be a non-negative integer.
{
"author_handle": "test@datadoghq.com",
"author_name": "John Doe",
"created_at": "2019-09-19T10:00:00.000Z",
"default_timeframe": {
"type": "live",
"unit": "minute",
"value": 4
},
"description": "string",
"experience_type": "default",
"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.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Item Not Found
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Exemple de code
# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"// 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())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" 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();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java""""
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()
configuration.access_token = environ["DD_BEARER_TOKEN"]
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# Get a dashboard returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"// 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.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.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({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"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.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"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.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"