ノートブックを更新する
https://api.datadoghq.com/api/v1/notebooks/{notebook_id}https://api.us3.datadoghq.com/api/v1/notebooks/{notebook_id}https://api.us5.datadoghq.com/api/v1/notebooks/{notebook_id}https://api.datadoghq.eu/api/v1/notebooks/{notebook_id}https://api.ap1.datadoghq.com/api/v1/notebooks/{notebook_id}https://api.ap2.datadoghq.com/api/v1/notebooks/{notebook_id}https://api.uk1.datadoghq.com/api/v1/notebooks/{notebook_id}https://api.ddog-gov.com/api/v1/notebooks/{notebook_id}https://api.us2.ddog-gov.com/api/v1/notebooks/{notebook_id}概要
指定された ID を使用してノートブックを更新します。
引数
パスパラメーター
notebook_id [required]Unique ID, assigned when you create the notebook.
リクエスト
Body Data (required)
ノートブックリクエストボディを更新します。
data [required]ノートブック更新リクエストの説明。
attributes [required]The data attributes of a notebook.
cells [required]List of cells to display in the notebook.
Object 1The description of a notebook cell create request.
attributes [required]The attributes of a notebook cell in create cell request. Valid cell types are markdown, timeseries, toplist, heatmap, distribution,
log_stream. More information on each graph visualization type.
Object 1The attributes of a notebook markdown cell.
definition [required]Text in a notebook is formatted with Markdown, which enables the use of headings, subheadings, links, images, lists, and code blocks.
text [required]The markdown content.
type [required]Type of the markdown cell.
markdownmarkdownObject 2The attributes of a notebook timeseries cell.
definition [required]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.
indexA 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.
indexA 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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
indexA 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.
indexA 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).
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 3The attributes of a notebook toplist cell.
definition [required]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.
indexA 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.
indexA 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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
indexA 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.
indexA 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.
<type=group>The group to sort the widget by.
styleDefine 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.
toplisttoplistgraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 4The attributes of a notebook heatmap cell.
definition [required]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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
indexA 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.
indexA 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).
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 5The attributes of a notebook distribution cell.
definition [required]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.
indexA 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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
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.
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.
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.
indexA 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.
indexA 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.
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 6The attributes of a notebook log_stream cell.
definition [required]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_streamgraph_sizeThe size of the graph.
xs, s, m, l, xltimeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
type [required]Type of the Notebook Cell resource.
notebook_cellsnotebook_cellsObject 2The description of a notebook cell update request.
attributes [required]The attributes of a notebook cell in update cell request. Valid cell types are markdown, timeseries, toplist, heatmap, distribution,
log_stream. More information on each graph visualization type.
Object 1The attributes of a notebook markdown cell.
definition [required]Text in a notebook is formatted with Markdown, which enables the use of headings, subheadings, links, images, lists, and code blocks.
text [required]The markdown content.
type [required]Type of the markdown cell.
markdownmarkdownObject 2The attributes of a notebook timeseries cell.
definition [required]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.
indexA 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.
indexA 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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
indexA 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.
indexA 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).
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 3The attributes of a notebook toplist cell.
definition [required]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.
indexA 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.
indexA 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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
indexA 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.
indexA 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.
<type=group>The group to sort the widget by.
styleDefine 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.
toplisttoplistgraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 4The attributes of a notebook heatmap cell.
definition [required]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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
indexA 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.
indexA 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).
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 5The attributes of a notebook distribution cell.
definition [required]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.
indexA 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.
indexA 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.
unit_scaleThe definition of NumberFormatUnitScale object.
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.
indexA 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.
indexA 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.
indexA 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.
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.
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.
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.
compute [required]Compute configuration for Product Analytics Extended queries.
data_source [required]Data source for Product Analytics Extended queries.
product_analytics_extendedgroup_byGroup by configuration.
indexesEvent indexes to query.
name [required]Name of the query for use in formulas.
query [required]Base query for Product Analytics.
<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.
data_source [required]Data source for user journey funnel queries.
product_analytics_journeygroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]User journey search configuration.
<data_source=product_analytics_retention>A formula and functions Retention query for defining timeseries and scalar visualizations.
compute [required]Compute configuration for retention queries.
data_source [required]Data source for retention queries.
product_analytics_retentiongroup_byGroup by configuration.
name [required]Name of the query for use in formulas.
search [required]Search configuration for retention queries.
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.
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.
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.
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.
indexA 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.
indexA 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.
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 6The attributes of a notebook log_stream cell.
definition [required]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_streamgraph_sizeThe size of the graph.
xs, s, m, l, xltimeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
id [required]Notebook cell ID.
type [required]Type of the Notebook Cell resource.
notebook_cellsnotebook_cellsmetadataMetadata associated with the notebook.
is_templateWhether or not the notebook is a template.
falsetake_snapshotsWhether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs.
falsetypeMetadata type of the notebook.
postmortem, runbook, investigation, documentation, reportname [required]The name of the notebook.
statusPublication status of the notebook. For now, always "published".
publishedpublishedtemplate_variablesList of template variables for this notebook.
available_valuesThe list of values that the template variable drop-down is limited to.
available_values_queryQuery used to dynamically populate the list of available values for the template variable.
Object 1Available values query for logs, RUM, or spans data sources.
data_source [required]The data source for the query. Must be one of logs, rum, or spans.
group_by [required]Group-by fields for the query.
facet [required]The facet name to group by.
search [required]Search parameters for an available values query.
query [required]The search query string.
Object 2Available values query for the metrics data source.
data_source [required]The data source for the query. Must be metrics.
query [required]The metrics query string.
data_source_mappingsMapping of data source names to template variable values.
<any-key>The value for the given data source.
defaultDEPRECATED (deprecated) The default value for the template variable on notebook load.
Cannot be used in conjunction with defaults.
defaultsOne or many default values for the template variable. Cannot be used in conjunction with default.
name [required]The name of the variable.
placementThe placement of the template variable in the notebook.
prefixThe tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
typeThe type of the template variable.
time [required]Notebook global timeframe.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
type [required]Type of the Notebook resource.
notebooksnotebooks{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}応答
OK
The description of a notebook response.
dataThe data for a notebook.
attributes [required]The attributes of a notebook.
authorAttributes of user object returned by the API.
created_atCreation time of the user.
disabledWhether the user is disabled.
emailEmail of the user.
handleHandle of the user.
iconURL of the user's icon.
nameName of the user.
statusStatus of the user.
titleTitle of the user.
verifiedWhether the user is verified.
cells [required]List of cells to display in the notebook.
attributes [required]The attributes of a notebook cell response. Valid cell types are markdown, timeseries, toplist, heatmap, distribution,
log_stream. More information on each graph visualization type.
Object 1The attributes of a notebook markdown cell.
definition [required]Text in a notebook is formatted with Markdown, which enables the use of headings, subheadings, links, images, lists, and code blocks.
text [required]The markdown content.
type [required]Type of the markdown cell.
markdownmarkdownObject 2The attributes of a notebook timeseries cell.
definition [required]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.
<type=custom_unit_label>Custom unit.
unit_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.
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_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).
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 3The attributes of a notebook toplist cell.
definition [required]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.
<type=custom_unit_label>Custom unit.
unit_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.
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_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.
toplisttoplistgraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 4The attributes of a notebook heatmap cell.
definition [required]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.
<type=custom_unit_label>Custom unit.
unit_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.
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.
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).
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 5The attributes of a notebook distribution cell.
definition [required]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.
<type=custom_unit_label>Custom unit.
unit_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.
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.
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.
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.
<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.
lineargraph_sizeThe size of the graph.
xs, s, m, l, xlsplit_byObject describing how to split the graph to display multiple visualizations per request.
keys [required]Keys to split on.
tags [required]Tags to split on.
timeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
Object 6The attributes of a notebook log_stream cell.
definition [required]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_streamgraph_sizeThe size of the graph.
xs, s, m, l, xltimeTimeframe for the notebook cell. When 'null', the notebook global time is used.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
id [required]Notebook cell ID.
type [required]Type of the Notebook Cell resource.
notebook_cellsnotebook_cellscreatedUTC time stamp for when the notebook was created.
metadataMetadata associated with the notebook.
is_templateWhether or not the notebook is a template.
falsetake_snapshotsWhether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs.
falsetypeMetadata type of the notebook.
postmortem, runbook, investigation, documentation, reportmodifiedUTC time stamp for when the notebook was last modified.
name [required]The name of the notebook.
statusPublication status of the notebook. For now, always "published".
publishedpublishedtemplate_variablesList of template variables for this notebook.
available_valuesThe list of values that the template variable drop-down is limited to.
available_values_queryQuery used to dynamically populate the list of available values for the template variable.
Object 1Available values query for logs, RUM, or spans data sources.
data_source [required]The data source for the query. Must be one of logs, rum, or spans.
group_by [required]Group-by fields for the query.
facet [required]The facet name to group by.
search [required]Search parameters for an available values query.
query [required]The search query string.
Object 2Available values query for the metrics data source.
data_source [required]The data source for the query. Must be metrics.
query [required]The metrics query string.
data_source_mappingsMapping of data source names to template variable values.
<any-key>The value for the given data source.
defaultDEPRECATED (deprecated) The default value for the template variable on notebook load.
Cannot be used in conjunction with defaults.
defaultsOne or many default values for the template variable. Cannot be used in conjunction with default.
name [required]The name of the variable.
placementThe placement of the template variable in the notebook.
prefixThe tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
typeThe type of the template variable.
time [required]Notebook global timeframe.
Object 1Relative timeframe.
live_span [required]The 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, alertObject 2Absolute timeframe.
end [required]The end time.
liveIndicates whether the timeframe should be shifted to end at the current time.
start [required]The start time.
id [required]Unique notebook ID, assigned when you create the notebook.
type [required]Type of the Notebook resource.
notebooksnotebooks{
"data": {
"attributes": {
"author": {
"created_at": "2019-09-19T10:00:00.000Z",
"disabled": false,
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"status": "string",
"title": "string",
"verified": false
},
"cells": [
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"id": "abcd1234",
"type": "notebook_cells"
}
],
"created": "2021-02-24T23:14:15.173964+00:00",
"metadata": {
"is_template": false,
"take_snapshots": false,
"type": "investigation"
},
"modified": "2021-02-24T23:15:23.274966+00:00",
"name": "Example Notebook",
"status": "published",
"template_variables": [
{
"available_values": [
"my-host",
"host1",
"host2"
],
"available_values_query": {
"data_source": "logs",
"group_by": [
{
"facet": "host"
}
],
"search": {
"query": "service:web"
}
},
"data_source_mappings": {
"<any-key>": "string"
},
"default": "my-host",
"defaults": [
"my-host-1",
"my-host-2"
],
"name": "host1",
"placement": "global",
"prefix": "host",
"type": "tag"
}
],
"time": {
"live_span": "5m"
}
},
"id": 123456,
"type": "notebooks"
}
}Bad Request
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Authentication Error
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Not Found
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Conflict
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"
]
}コード例
# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF# Path parameters
export notebook_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 PUT "https://api.${DD_SITE}/api/v1/notebooks/${notebook_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example-Notebook-updated",
"status": "published",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}
EOF// Update a notebook returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"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 "notebook" in the system
NotebookDataID, _ := strconv.ParseInt(os.Getenv("NOTEBOOK_DATA_ID"), 10, 64)
body := datadogV1.NotebookUpdateRequest{
Data: datadogV1.NotebookUpdateData{
Attributes: datadogV1.NotebookUpdateDataAttributes{
Cells: []datadogV1.NotebookUpdateCell{
datadogV1.NotebookUpdateCell{
NotebookCellCreateRequest: &datadogV1.NotebookCellCreateRequest{
Attributes: datadogV1.NotebookCellCreateRequestAttributes{
NotebookMarkdownCellAttributes: &datadogV1.NotebookMarkdownCellAttributes{
Definition: datadogV1.NotebookMarkdownCellDefinition{
Text: `## Some test markdown
` + "```" + `
var x, y;
x = 5;
y = 6;
` + "```",
Type: datadogV1.NOTEBOOKMARKDOWNCELLDEFINITIONTYPE_MARKDOWN,
},
}},
Type: datadogV1.NOTEBOOKCELLRESOURCETYPE_NOTEBOOK_CELLS,
}},
datadogV1.NotebookUpdateCell{
NotebookCellCreateRequest: &datadogV1.NotebookCellCreateRequest{
Attributes: datadogV1.NotebookCellCreateRequestAttributes{
NotebookTimeseriesCellAttributes: &datadogV1.NotebookTimeseriesCellAttributes{
Definition: datadogV1.TimeseriesWidgetDefinition{
Requests: []datadogV1.TimeseriesWidgetRequest{
{
DisplayType: datadogV1.WIDGETDISPLAYTYPE_LINE.Ptr(),
Q: datadog.PtrString("avg:system.load.1{*}"),
Style: &datadogV1.TimeseriesRequestStyle{
LineType: datadogV1.WIDGETLINETYPE_SOLID.Ptr(),
LineWidth: datadogV1.WIDGETLINEWIDTH_NORMAL.Ptr(),
Palette: datadog.PtrString("dog_classic"),
},
},
},
ShowLegend: datadog.PtrBool(true),
Type: datadogV1.TIMESERIESWIDGETDEFINITIONTYPE_TIMESERIES,
Yaxis: &datadogV1.WidgetAxis{
Scale: datadog.PtrString("linear"),
},
},
GraphSize: datadogV1.NOTEBOOKGRAPHSIZE_MEDIUM.Ptr(),
SplitBy: &datadogV1.NotebookSplitBy{
Keys: []string{},
Tags: []string{},
},
Time: *datadogV1.NewNullableNotebookCellTime(nil),
}},
Type: datadogV1.NOTEBOOKCELLRESOURCETYPE_NOTEBOOK_CELLS,
}},
},
Name: "Example-Notebook-updated",
Status: datadogV1.NOTEBOOKSTATUS_PUBLISHED.Ptr(),
Time: datadogV1.NotebookGlobalTime{
NotebookRelativeTime: &datadogV1.NotebookRelativeTime{
LiveSpan: datadogV1.WIDGETLIVESPAN_PAST_ONE_HOUR,
}},
},
Type: datadogV1.NOTEBOOKRESOURCETYPE_NOTEBOOKS,
},
}
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.NewNotebooksApi(apiClient)
resp, r, err := api.UpdateNotebook(ctx, NotebookDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NotebooksApi.UpdateNotebook`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `NotebooksApi.UpdateNotebook`:\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"// Update a notebook returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.NotebooksApi;
import com.datadog.api.client.v1.model.NotebookCellCreateRequest;
import com.datadog.api.client.v1.model.NotebookCellCreateRequestAttributes;
import com.datadog.api.client.v1.model.NotebookCellResourceType;
import com.datadog.api.client.v1.model.NotebookGlobalTime;
import com.datadog.api.client.v1.model.NotebookGraphSize;
import com.datadog.api.client.v1.model.NotebookMarkdownCellAttributes;
import com.datadog.api.client.v1.model.NotebookMarkdownCellDefinition;
import com.datadog.api.client.v1.model.NotebookMarkdownCellDefinitionType;
import com.datadog.api.client.v1.model.NotebookRelativeTime;
import com.datadog.api.client.v1.model.NotebookResourceType;
import com.datadog.api.client.v1.model.NotebookResponse;
import com.datadog.api.client.v1.model.NotebookSplitBy;
import com.datadog.api.client.v1.model.NotebookStatus;
import com.datadog.api.client.v1.model.NotebookTimeseriesCellAttributes;
import com.datadog.api.client.v1.model.NotebookUpdateCell;
import com.datadog.api.client.v1.model.NotebookUpdateData;
import com.datadog.api.client.v1.model.NotebookUpdateDataAttributes;
import com.datadog.api.client.v1.model.NotebookUpdateRequest;
import com.datadog.api.client.v1.model.TimeseriesRequestStyle;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinition;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;
import com.datadog.api.client.v1.model.TimeseriesWidgetRequest;
import com.datadog.api.client.v1.model.WidgetAxis;
import com.datadog.api.client.v1.model.WidgetDisplayType;
import com.datadog.api.client.v1.model.WidgetLineType;
import com.datadog.api.client.v1.model.WidgetLineWidth;
import com.datadog.api.client.v1.model.WidgetLiveSpan;
import java.util.Arrays;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
NotebooksApi apiInstance = new NotebooksApi(defaultClient);
// there is a valid "notebook" in the system
Long NOTEBOOK_DATA_ID = Long.parseLong(System.getenv("NOTEBOOK_DATA_ID"));
NotebookUpdateRequest body =
new NotebookUpdateRequest()
.data(
new NotebookUpdateData()
.attributes(
new NotebookUpdateDataAttributes()
.cells(
Arrays.asList(
new NotebookUpdateCell(
new NotebookCellCreateRequest()
.attributes(
new NotebookCellCreateRequestAttributes(
new NotebookMarkdownCellAttributes()
.definition(
new NotebookMarkdownCellDefinition()
.text(
"""
## Some test markdown
```
var x, y;
x = 5;
y = 6;
```
""")
.type(
NotebookMarkdownCellDefinitionType
.MARKDOWN))))
.type(NotebookCellResourceType.NOTEBOOK_CELLS)),
new NotebookUpdateCell(
new NotebookCellCreateRequest()
.attributes(
new NotebookCellCreateRequestAttributes(
new NotebookTimeseriesCellAttributes()
.definition(
new TimeseriesWidgetDefinition()
.requests(
Collections.singletonList(
new TimeseriesWidgetRequest()
.displayType(
WidgetDisplayType
.LINE)
.q(
"avg:system.load.1{*}")
.style(
new TimeseriesRequestStyle()
.lineType(
WidgetLineType
.SOLID)
.lineWidth(
WidgetLineWidth
.NORMAL)
.palette(
"dog_classic"))))
.showLegend(true)
.type(
TimeseriesWidgetDefinitionType
.TIMESERIES)
.yaxis(
new WidgetAxis()
.scale("linear")))
.graphSize(NotebookGraphSize.MEDIUM)
.splitBy(new NotebookSplitBy())
.time(null)))
.type(NotebookCellResourceType.NOTEBOOK_CELLS))))
.name("Example-Notebook-updated")
.status(NotebookStatus.PUBLISHED)
.time(
new NotebookGlobalTime(
new NotebookRelativeTime()
.liveSpan(WidgetLiveSpan.PAST_ONE_HOUR))))
.type(NotebookResourceType.NOTEBOOKS));
try {
NotebookResponse result = apiInstance.updateNotebook(NOTEBOOK_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotebooksApi#updateNotebook");
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""""
Update a notebook returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.notebooks_api import NotebooksApi
from datadog_api_client.v1.model.notebook_cell_create_request import NotebookCellCreateRequest
from datadog_api_client.v1.model.notebook_cell_resource_type import NotebookCellResourceType
from datadog_api_client.v1.model.notebook_graph_size import NotebookGraphSize
from datadog_api_client.v1.model.notebook_markdown_cell_attributes import NotebookMarkdownCellAttributes
from datadog_api_client.v1.model.notebook_markdown_cell_definition import NotebookMarkdownCellDefinition
from datadog_api_client.v1.model.notebook_markdown_cell_definition_type import NotebookMarkdownCellDefinitionType
from datadog_api_client.v1.model.notebook_relative_time import NotebookRelativeTime
from datadog_api_client.v1.model.notebook_resource_type import NotebookResourceType
from datadog_api_client.v1.model.notebook_split_by import NotebookSplitBy
from datadog_api_client.v1.model.notebook_status import NotebookStatus
from datadog_api_client.v1.model.notebook_timeseries_cell_attributes import NotebookTimeseriesCellAttributes
from datadog_api_client.v1.model.notebook_update_data import NotebookUpdateData
from datadog_api_client.v1.model.notebook_update_data_attributes import NotebookUpdateDataAttributes
from datadog_api_client.v1.model.notebook_update_request import NotebookUpdateRequest
from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle
from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition
from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType
from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest
from datadog_api_client.v1.model.widget_axis import WidgetAxis
from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType
from datadog_api_client.v1.model.widget_line_type import WidgetLineType
from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth
from datadog_api_client.v1.model.widget_live_span import WidgetLiveSpan
# there is a valid "notebook" in the system
NOTEBOOK_DATA_ID = environ["NOTEBOOK_DATA_ID"]
body = NotebookUpdateRequest(
data=NotebookUpdateData(
attributes=NotebookUpdateDataAttributes(
cells=[
NotebookCellCreateRequest(
attributes=NotebookMarkdownCellAttributes(
definition=NotebookMarkdownCellDefinition(
text="## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```",
type=NotebookMarkdownCellDefinitionType.MARKDOWN,
),
),
type=NotebookCellResourceType.NOTEBOOK_CELLS,
),
NotebookCellCreateRequest(
attributes=NotebookTimeseriesCellAttributes(
definition=TimeseriesWidgetDefinition(
requests=[
TimeseriesWidgetRequest(
display_type=WidgetDisplayType.LINE,
q="avg:system.load.1{*}",
style=TimeseriesRequestStyle(
line_type=WidgetLineType.SOLID,
line_width=WidgetLineWidth.NORMAL,
palette="dog_classic",
),
),
],
show_legend=True,
type=TimeseriesWidgetDefinitionType.TIMESERIES,
yaxis=WidgetAxis(
scale="linear",
),
),
graph_size=NotebookGraphSize.MEDIUM,
split_by=NotebookSplitBy(
keys=[],
tags=[],
),
time=None,
),
type=NotebookCellResourceType.NOTEBOOK_CELLS,
),
],
name="Example-Notebook-updated",
status=NotebookStatus.PUBLISHED,
time=NotebookRelativeTime(
live_span=WidgetLiveSpan.PAST_ONE_HOUR,
),
),
type=NotebookResourceType.NOTEBOOKS,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = NotebooksApi(api_client)
response = api_instance.update_notebook(notebook_id=int(NOTEBOOK_DATA_ID), body=body)
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"# Update a notebook returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V1::NotebooksAPI.new
# there is a valid "notebook" in the system
NOTEBOOK_DATA_ID = ENV["NOTEBOOK_DATA_ID"]
body = DatadogAPIClient::V1::NotebookUpdateRequest.new({
data: DatadogAPIClient::V1::NotebookUpdateData.new({
attributes: DatadogAPIClient::V1::NotebookUpdateDataAttributes.new({
cells: [
DatadogAPIClient::V1::NotebookCellCreateRequest.new({
attributes: DatadogAPIClient::V1::NotebookMarkdownCellAttributes.new({
definition: DatadogAPIClient::V1::NotebookMarkdownCellDefinition.new({
text: '## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```',
type: DatadogAPIClient::V1::NotebookMarkdownCellDefinitionType::MARKDOWN,
}),
}),
type: DatadogAPIClient::V1::NotebookCellResourceType::NOTEBOOK_CELLS,
}),
DatadogAPIClient::V1::NotebookCellCreateRequest.new({
attributes: DatadogAPIClient::V1::NotebookTimeseriesCellAttributes.new({
definition: DatadogAPIClient::V1::TimeseriesWidgetDefinition.new({
requests: [
DatadogAPIClient::V1::TimeseriesWidgetRequest.new({
display_type: DatadogAPIClient::V1::WidgetDisplayType::LINE,
q: "avg:system.load.1{*}",
style: DatadogAPIClient::V1::TimeseriesRequestStyle.new({
line_type: DatadogAPIClient::V1::WidgetLineType::SOLID,
line_width: DatadogAPIClient::V1::WidgetLineWidth::NORMAL,
palette: "dog_classic",
}),
}),
],
show_legend: true,
type: DatadogAPIClient::V1::TimeseriesWidgetDefinitionType::TIMESERIES,
yaxis: DatadogAPIClient::V1::WidgetAxis.new({
scale: "linear",
}),
}),
graph_size: DatadogAPIClient::V1::NotebookGraphSize::MEDIUM,
split_by: DatadogAPIClient::V1::NotebookSplitBy.new({
keys: [],
tags: [],
}),
time: nil,
}),
type: DatadogAPIClient::V1::NotebookCellResourceType::NOTEBOOK_CELLS,
}),
],
name: "Example-Notebook-updated",
status: DatadogAPIClient::V1::NotebookStatus::PUBLISHED,
time: DatadogAPIClient::V1::NotebookRelativeTime.new({
live_span: DatadogAPIClient::V1::WidgetLiveSpan::PAST_ONE_HOUR,
}),
}),
type: DatadogAPIClient::V1::NotebookResourceType::NOTEBOOKS,
}),
})
p api_instance.update_notebook(NOTEBOOK_DATA_ID.to_i, body)
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"// Update a notebook returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_notebooks::NotebooksAPI;
use datadog_api_client::datadogV1::model::NotebookCellCreateRequest;
use datadog_api_client::datadogV1::model::NotebookCellCreateRequestAttributes;
use datadog_api_client::datadogV1::model::NotebookCellResourceType;
use datadog_api_client::datadogV1::model::NotebookGlobalTime;
use datadog_api_client::datadogV1::model::NotebookGraphSize;
use datadog_api_client::datadogV1::model::NotebookMarkdownCellAttributes;
use datadog_api_client::datadogV1::model::NotebookMarkdownCellDefinition;
use datadog_api_client::datadogV1::model::NotebookMarkdownCellDefinitionType;
use datadog_api_client::datadogV1::model::NotebookRelativeTime;
use datadog_api_client::datadogV1::model::NotebookResourceType;
use datadog_api_client::datadogV1::model::NotebookSplitBy;
use datadog_api_client::datadogV1::model::NotebookStatus;
use datadog_api_client::datadogV1::model::NotebookTimeseriesCellAttributes;
use datadog_api_client::datadogV1::model::NotebookUpdateCell;
use datadog_api_client::datadogV1::model::NotebookUpdateData;
use datadog_api_client::datadogV1::model::NotebookUpdateDataAttributes;
use datadog_api_client::datadogV1::model::NotebookUpdateRequest;
use datadog_api_client::datadogV1::model::TimeseriesRequestStyle;
use datadog_api_client::datadogV1::model::TimeseriesWidgetDefinition;
use datadog_api_client::datadogV1::model::TimeseriesWidgetDefinitionType;
use datadog_api_client::datadogV1::model::TimeseriesWidgetRequest;
use datadog_api_client::datadogV1::model::WidgetAxis;
use datadog_api_client::datadogV1::model::WidgetDisplayType;
use datadog_api_client::datadogV1::model::WidgetLineType;
use datadog_api_client::datadogV1::model::WidgetLineWidth;
use datadog_api_client::datadogV1::model::WidgetLiveSpan;
#[tokio::main]
async fn main() {
// there is a valid "notebook" in the system
let notebook_data_id: i64 = std::env::var("NOTEBOOK_DATA_ID").unwrap().parse().unwrap();
let body = NotebookUpdateRequest::new(NotebookUpdateData::new(
NotebookUpdateDataAttributes::new(
vec![
NotebookUpdateCell::NotebookCellCreateRequest(Box::new(
NotebookCellCreateRequest::new(
NotebookCellCreateRequestAttributes::NotebookMarkdownCellAttributes(
Box::new(NotebookMarkdownCellAttributes::new(
NotebookMarkdownCellDefinition::new(
r#"## Some test markdown
```
var x, y;
x = 5;
y = 6;
```"#
.to_string(),
NotebookMarkdownCellDefinitionType::MARKDOWN,
),
)),
),
NotebookCellResourceType::NOTEBOOK_CELLS,
),
)),
NotebookUpdateCell::NotebookCellCreateRequest(Box::new(
NotebookCellCreateRequest::new(
NotebookCellCreateRequestAttributes::NotebookTimeseriesCellAttributes(
Box::new(
NotebookTimeseriesCellAttributes::new(
TimeseriesWidgetDefinition::new(
vec![TimeseriesWidgetRequest::new()
.display_type(WidgetDisplayType::LINE)
.q("avg:system.load.1{*}".to_string())
.style(
TimeseriesRequestStyle::new()
.line_type(WidgetLineType::SOLID)
.line_width(WidgetLineWidth::NORMAL)
.palette("dog_classic".to_string()),
)],
TimeseriesWidgetDefinitionType::TIMESERIES,
)
.show_legend(true)
.yaxis(WidgetAxis::new().scale("linear".to_string())),
)
.graph_size(NotebookGraphSize::MEDIUM)
.split_by(NotebookSplitBy::new(vec![], vec![]))
.time(None),
),
),
NotebookCellResourceType::NOTEBOOK_CELLS,
),
)),
],
"Example-Notebook-updated".to_string(),
NotebookGlobalTime::NotebookRelativeTime(Box::new(NotebookRelativeTime::new(
WidgetLiveSpan::PAST_ONE_HOUR,
))),
)
.status(NotebookStatus::PUBLISHED),
NotebookResourceType::NOTEBOOKS,
));
let configuration = datadog::Configuration::new();
let api = NotebooksAPI::with_config(configuration);
let resp = api.update_notebook(notebook_data_id.clone(), body).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="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run/**
* Update a notebook 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.NotebooksApi(configuration);
// there is a valid "notebook" in the system
const NOTEBOOK_DATA_ID = parseInt(process.env.NOTEBOOK_DATA_ID as string);
const params: v1.NotebooksApiUpdateNotebookRequest = {
body: {
data: {
attributes: {
cells: [
{
attributes: {
definition: {
text:
`## Some test markdown
` +
"```" +
`
var x, y;
x = 5;
y = 6;
` +
"```",
type: "markdown",
},
},
type: "notebook_cells",
},
{
attributes: {
definition: {
requests: [
{
displayType: "line",
q: "avg:system.load.1{*}",
style: {
lineType: "solid",
lineWidth: "normal",
palette: "dog_classic",
},
},
],
showLegend: true,
type: "timeseries",
yaxis: {
scale: "linear",
},
},
graphSize: "m",
splitBy: {
keys: [],
tags: [],
},
time: undefined,
},
type: "notebook_cells",
},
],
name: "Example-Notebook-updated",
status: "published",
time: {
liveSpan: "1h",
},
},
type: "notebooks",
},
},
notebookId: NOTEBOOK_DATA_ID,
};
apiInstance
.updateNotebook(params)
.then((data: v1.NotebookResponse) => {
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"