--- title: Host Map Widget description: Display the Datadog host map in your dashboards. breadcrumbs: Docs > Dashboards > Widgets > Host Map Widget --- # Host Map Widget The host map widget graphs any metric across your hosts using the same visualization available from the main [Host Map](https://docs.datadoghq.com/infrastructure/hostmap.md) page: {% image source="https://docs.dd-static.net/images/dashboards/widgets/hostmap/hostmap.e3ed7a7e8d381986676e0e399eea9157.png?auto=format&fit=max&w=850 1x, https://docs.dd-static.net/images/dashboards/widgets/hostmap/hostmap.e3ed7a7e8d381986676e0e399eea9157.png?auto=format&fit=max&w=850&dpr=2 2x" alt="Host Map" /%} ## Setup{% #setup %} {% image source="https://docs.dd-static.net/images/dashboards/widgets/hostmap/hostmap_setup.565d79299814f39be5b9e3e03bebe2d3.png?auto=format&fit=max&w=850 1x, https://docs.dd-static.net/images/dashboards/widgets/hostmap/hostmap_setup.565d79299814f39be5b9e3e03bebe2d3.png?auto=format&fit=max&w=850&dpr=2 2x" alt="Host Map Setup" /%} ### Configuration{% #configuration %} Configuration of the host map widget is similar to the main [host map](https://docs.datadoghq.com/infrastructure/hostmap.md) page: 1. Type: Choose to display `hosts` or `containers`. 1. Filter by: Choose the hosts or containers to display. 1. Group by: Aggregate your hosts or containers by one or several tags. 1. Fill by: Choose a metric to fill your host or container map elements. 1. Size by (optional): Choose a metric to size your host or container map elements. 1. Palette (optional): Choose a color palette. 1. Values (optional): Define the min and max color palette fill values. **Note**: Free text search is not available for the host map widget. ### Options{% #options %} #### Context links{% #context-links %} [Context links](https://docs.datadoghq.com/dashboards/guide/context-links.md) are enabled by default; you can toggle them on or off. Context links connect dashboard widgets with other pages (in Datadog or third-party). ## API{% #api %} This widget can be used with the **[Dashboards API](https://docs.datadoghq.com/api/latest/dashboards.md)**. See the following table for the [widget JSON schema definition](https://docs.datadoghq.com/dashboards/graphing_json/widget_json.md): {% tab %} ModelExample {% tab title="-model" %} Expand AllFieldTypeDescription custom_links[object]List of custom links.is_hiddenbooleanThe flag for toggling context menu link visibility.labelstringThe label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.linkstringThe URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.override_labelstringThe label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.descriptionstringThe description of the widget.group[string]List of tag prefixes to group by.no_group_hostsbooleanWhether to show the hosts that don't fit in a group.no_metric_hostsbooleanWhether to show the hosts with no metrics.node_typeenumWhich type of node to use in the map. Allowed enum values: `host,container`notesstringNotes on the title. requests [*required*]objectQuery definition for the host map widget. Supports two mutually exclusive formats distinguished by the presence of `request_type`: the legacy metric-based format (`fill`/`size`) and the infrastructure-backed format (`request_type`, `node_type`, `enrichments`). childobjectInfrastructure-backed request for the host map widget. Supports entity-based visualization with metric query enrichments, tag-based filtering, flexible grouping, and hierarchical views. childobjectOptional child request for hierarchical visualization (for example, hosts containing containers). Maximum one level of nesting. conditional_formats[object]List of conditional formatting rules applied to fill values.comparator [*required*]enumComparator to apply. Allowed enum values: `=,>,>=,<,<=`custom_bg_colorstringColor palette to apply to the background, same values available as palette.custom_fg_colorstringColor palette to apply to the foreground, same values available as palette.hide_valuebooleanTrue hides values.image_urlstringDisplays an image as the background.metricstringMetric from the request to correlate this conditional format with.palette [*required*]enumColor palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white`Show 9 more`,white_on_gray,white_on_green,green_on_white,white_on_red,white_on_yellow,yellow_on_white,black_on_light_yellow,black_on_light_green,black_on_light_red` timeframestringDefines the displayed timeframe.value [*required*]doubleValue for the comparator. enrichments [*required*][object]Metric or event queries joined to the entity set. Each formula specifies a visual dimension. formulas [*required*][object]List of formulas that operate on queries, each assigned to a visual dimension.aliasstringExpression alias.dimension [*required*]enumVisual dimension driven by a formula in the infrastructure host map widget. Allowed enum values: `node,fill,size`formula [*required*]stringString expression built from queries, formulas, and functions. number_formatobjectNumber format options for the widget. unit Number format unit. Option 1objectCanonical unit.per_unit_namestringThe name of the unit per item.typeenumThe type of unit scale. Allowed enum values: `canonical_unit`unit_namestringThe name of the unit. Option 2objectCustom unit.labelstringThe label for the custom unit.typeenumThe type of custom unit. Allowed enum values: `custom_unit_label` unit_scaleobjectThe definition of `NumberFormatUnitScale` object.typeenumThe type of unit scale. Allowed enum values: `canonical_unit`unit_namestringThe name of the unit. queries [*required*][ ]List of queries that can be returned directly or used in formulas. Option 1objectA formula and functions metrics query.aggregatorenumThe aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for metrics queries. Allowed enum values: `metrics`name [*required*]stringName of the query for use in formulas.query [*required*]stringMetrics query definition.semantic_modeenumSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` Option 2objectA formula and functions events query. compute [*required*]objectCompute options.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervalint64A time interval in milliseconds.metricstringMeasurable attribute to compute.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines`Show 5 more`,incident_analytics,product_analytics,on_call_events,errors,llm_observability` group_by Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. Option 1[object]List of objects used to group by.facet [*required*]stringEvent facet.limitint64Number of groups to return. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` Option 2objectFlat group by configuration using multiple event facet fields.fields [*required*][string]List of event facets to group by.limitint64Number of groups to return. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` indexes[string]An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.name [*required*]stringName of the query for use in formulas. searchobjectSearch options.query [*required*]stringEvents search string.storagestringOption for storage location. Feature in Private Beta. Option 3objectProcess query using formulas and functions.aggregatorenumThe aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData sources that rely on the process backend. Allowed enum values: `process,container`is_normalized_cpubooleanWhether to normalize the CPU percentages.limitint64Number of hits to return.metric [*required*]stringProcess metric name.name [*required*]stringName of query for use in formulas.sortenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` tag_filters[string]An array of tags to filter by.text_filterstringText to use as filter. Option 4objectA formula and functions APM dependency stats query.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`env [*required*]stringAPM environment.is_upstreambooleanDetermines whether stats for upstream or downstream dependencies should be queried.name [*required*]stringName of query to use in formulas.operation_name [*required*]stringName of operation on service.primary_tag_namestringThe name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope.md#add-a-second-primary-tag-in-datadog).primary_tag_valuestringFilter APM data by the second primary tag. `primary_tag_name` must also be specified.resource_name [*required*]stringAPM resource.service [*required*]stringAPM service.stat [*required*]enumAPM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` Option 5object**DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for APM resource stats queries. Allowed enum values: `apm_resource_stats`env [*required*]stringAPM environment.group_by[string]Array of fields to group results by.name [*required*]stringName of this query to use in formulas.operation_namestringName of operation on service.primary_tag_namestringName of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope.md#add-a-second-primary-tag-in-datadog)primary_tag_valuestringValue of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.resource_namestringAPM resource name.service [*required*]stringAPM service name.stat [*required*]enumAPM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95`Show 1 more`,latency_p99` Option 6objectA formula and functions APM metrics query.data_source [*required*]enumData source for APM metrics queries. Allowed enum values: `apm_metrics`group_by[string]Optional fields to group the query results by.name [*required*]stringName of this query to use in formulas.operation_modestringOptional operation mode to aggregate across operation names.operation_namestringName of operation on service. If not provided, the primary operation name is used.peer_tags[string]Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).query_filterstringAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).resource_hashstringThe hash of a specific resource to filter by.resource_namestringThe full name of a specific resource to filter by.servicestringAPM service name.span_kindenumDescribes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal`stat [*required*]enumAPM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`Show 6 more`,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex` Option 7objectA formula and functions metrics query.additional_query_filtersstringAdditional filters applied to the SLO query.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for SLO measures queries. Allowed enum values: `slo`group_modeenumGroup mode to query measures. Allowed enum values: `overall,components`measure [*required*]enumSLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`namestringName of the query for use in formulas.slo_id [*required*]stringID of an SLO to query measures.slo_query_typeenumName of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` Option 8objectA formula and functions Cloud Cost query.aggregatorenumAggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for Cloud Cost queries. Allowed enum values: `cloud_cost`name [*required*]stringName of the query for use in formulas.query [*required*]stringQuery for Cloud Cost data. Option 9objectA formula and functions Product Analytics Extended query for advanced analytics features. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery. compute [*required*]objectCompute configuration for Product Analytics Extended queries.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervaldoubleFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`.metricstringMeasurable attribute to compute.namestringName of the compute for use in formulas. rollupobjectCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`.alignmentstringAlignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`).quantityint64Quantity of the interval.timezonestringTimezone for the interval.type [*required*]enumType of calendar interval. Allowed enum values: `day,week,month,year,quarter,minute,hour`data_source [*required*]enumData source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended` group_by[object]Group by configuration.facet [*required*]stringFacet name to group by.limitint32Maximum number of groups to return.should_exclude_missingbooleanWhether to exclude events missing the group-by facet. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` indexes[string]Event indexes to query.name [*required*]stringName of the query for use in formulas. query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. Option 10objectA formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. compute [*required*]objectCompute configuration for User Journey formula queries.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervaldoubleTime bucket interval in milliseconds for time series queries.metricenumMetric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion,__dd.conversion_rate,__dd.time_to_convert` targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.data_source [*required*]enumData source for user journey funnel queries. Allowed enum values: `product_analytics_journey` group_by[object]Group by configuration.facet [*required*]stringFacet name to group by.limitint32Maximum number of groups to return.should_exclude_missingbooleanWhether to exclude events missing the group-by facet. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.name [*required*]stringName of the query for use in formulas. search [*required*]objectUser journey search configuration.expression [*required*]stringExpression string. filtersobjectFilters for user journey search. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery. graph_filters[object]Graph filters.namestringFilter name.operatorstringFilter operator. targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.valueint64Filter value.string_filterstringString filter. join_keysobjectJoin keys for user journey queries.primary [*required*]stringPrimary join key.secondary[string]Secondary join keys. node_objects [*required*]objectNode objects mapping. objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. step_aliasesobjectStep aliases mapping.string Option 11objectA formula and functions Retention query for defining timeseries and scalar visualizations. compute [*required*]objectCompute configuration for retention queries. aggregation [*required*] The type of aggregation that can be performed on events-based queries.Option 1enumStandard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent`Show 1 more`,sum` Option 2stringPercentile aggregation.metric [*required*]enumMetric for retention compute. Allowed enum values: `__dd.retention,__dd.retention_rate`data_source [*required*]enumData source for retention queries. Allowed enum values: `product_analytics_retention` group_by[object]Group by configuration.facet [*required*]stringFacet to group by.limitint64Maximum number of groups.should_exclude_missingbooleanWhether to exclude missing values. sortobjectSort configuration for retention group by.orderenumWidget sorting methods. Allowed enum values: `asc,desc`sourcestringSource field.target [*required*]enumTarget for retention group by. Allowed enum values: `cohort,return_period`name [*required*]stringName of the query for use in formulas. search [*required*]objectSearch configuration for retention queries. cohort_criteria [*required*]objectCohort criteria for retention queries. base_query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. time_interval [*required*]objectTime interval for cohort criteria.type [*required*]enumType of time interval for cohort criteria. Allowed enum values: `calendar` value [*required*]objectCalendar interval definition.alignmentstringAlignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`).quantityint64Quantity of the interval.timezonestringTimezone for the interval.type [*required*]enumType of calendar interval. Allowed enum values: `day,week,month,year,quarter,minute,hour` filtersobjectFilters for retention queries. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery.string_filterstringString filter.retention_entity [*required*]enumEntity to track for retention. Allowed enum values: `@usr.id,@account.id`return_condition [*required*]enumCondition for counting user return. Allowed enum values: `conversion_on,conversion_on_or_after` return_criteriaobjectReturn criteria for retention queries. base_query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. time_intervalobjectTime interval for return criteria.type [*required*]enumType of time interval for return criteria. Allowed enum values: `fixed`unit [*required*]enumUnit of time for retention return criteria interval. Allowed enum values: `day,week,month`value [*required*]doubleValue of the time interval.response_format [*required*]enumResponse format for the scalar formula request. Only `scalar` is supported. Allowed enum values: `scalar`filterstringFilter string for the entity set in tag format (for example, `env:prod`). group_by[object]Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy.column [*required*]stringColumn name from the entity table (for example, `cloud_provider`, `tags`, `labels`).keystringKey within the column for nested attribute types (for example, `service` within `tags`).no_group_hostsbooleanWhether to hide entities that have no group assignment.no_metric_hostsbooleanWhether to hide entities that have no enrichment data.node_type [*required*]enumWhich type of infrastructure entity to visualize in the host map. Allowed enum values: `host,container,pod,cluster`request_type [*required*]enumIdentifies this as an infrastructure-backed host map request. Allowed enum values: `infrastructure_hostmap` styleobjectStyle configuration for the infrastructure host map.fill_maxdoubleMaximum value for the fill color scale. Omit to use automatic scaling.fill_mindoubleMinimum value for the fill color scale. Omit to use automatic scaling.palettestringColor palette name or alias.palette_flipbooleanWhether to invert the color palette. conditional_formats[object]List of conditional formatting rules applied to fill values.comparator [*required*]enumComparator to apply. Allowed enum values: `=,>,>=,<,<=`custom_bg_colorstringColor palette to apply to the background, same values available as palette.custom_fg_colorstringColor palette to apply to the foreground, same values available as palette.hide_valuebooleanTrue hides values.image_urlstringDisplays an image as the background.metricstringMetric from the request to correlate this conditional format with.palette [*required*]enumColor palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white`Show 9 more`,white_on_gray,white_on_green,green_on_white,white_on_red,white_on_yellow,yellow_on_white,black_on_light_yellow,black_on_light_green,black_on_light_red` timeframestringDefines the displayed timeframe.value [*required*]doubleValue for the comparator. enrichments [*required*][object]Metric or event queries joined to the entity set. Each formula specifies a visual dimension. formulas [*required*][object]List of formulas that operate on queries, each assigned to a visual dimension.aliasstringExpression alias.dimension [*required*]enumVisual dimension driven by a formula in the infrastructure host map widget. Allowed enum values: `node,fill,size`formula [*required*]stringString expression built from queries, formulas, and functions. number_formatobjectNumber format options for the widget. unit Number format unit. Option 1objectCanonical unit.per_unit_namestringThe name of the unit per item.typeenumThe type of unit scale. Allowed enum values: `canonical_unit`unit_namestringThe name of the unit. Option 2objectCustom unit.labelstringThe label for the custom unit.typeenumThe type of custom unit. Allowed enum values: `custom_unit_label` unit_scaleobjectThe definition of `NumberFormatUnitScale` object.typeenumThe type of unit scale. Allowed enum values: `canonical_unit`unit_namestringThe name of the unit. queries [*required*][ ]List of queries that can be returned directly or used in formulas. Option 1objectA formula and functions metrics query.aggregatorenumThe aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for metrics queries. Allowed enum values: `metrics`name [*required*]stringName of the query for use in formulas.query [*required*]stringMetrics query definition.semantic_modeenumSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` Option 2objectA formula and functions events query. compute [*required*]objectCompute options.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervalint64A time interval in milliseconds.metricstringMeasurable attribute to compute.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines`Show 5 more`,incident_analytics,product_analytics,on_call_events,errors,llm_observability` group_by Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. Option 1[object]List of objects used to group by.facet [*required*]stringEvent facet.limitint64Number of groups to return. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` Option 2objectFlat group by configuration using multiple event facet fields.fields [*required*][string]List of event facets to group by.limitint64Number of groups to return. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` indexes[string]An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.name [*required*]stringName of the query for use in formulas. searchobjectSearch options.query [*required*]stringEvents search string.storagestringOption for storage location. Feature in Private Beta. Option 3objectProcess query using formulas and functions.aggregatorenumThe aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData sources that rely on the process backend. Allowed enum values: `process,container`is_normalized_cpubooleanWhether to normalize the CPU percentages.limitint64Number of hits to return.metric [*required*]stringProcess metric name.name [*required*]stringName of query for use in formulas.sortenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` tag_filters[string]An array of tags to filter by.text_filterstringText to use as filter. Option 4objectA formula and functions APM dependency stats query.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`env [*required*]stringAPM environment.is_upstreambooleanDetermines whether stats for upstream or downstream dependencies should be queried.name [*required*]stringName of query to use in formulas.operation_name [*required*]stringName of operation on service.primary_tag_namestringThe name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope.md#add-a-second-primary-tag-in-datadog).primary_tag_valuestringFilter APM data by the second primary tag. `primary_tag_name` must also be specified.resource_name [*required*]stringAPM resource.service [*required*]stringAPM service.stat [*required*]enumAPM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` Option 5object**DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for APM resource stats queries. Allowed enum values: `apm_resource_stats`env [*required*]stringAPM environment.group_by[string]Array of fields to group results by.name [*required*]stringName of this query to use in formulas.operation_namestringName of operation on service.primary_tag_namestringName of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope.md#add-a-second-primary-tag-in-datadog)primary_tag_valuestringValue of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.resource_namestringAPM resource name.service [*required*]stringAPM service name.stat [*required*]enumAPM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95`Show 1 more`,latency_p99` Option 6objectA formula and functions APM metrics query.data_source [*required*]enumData source for APM metrics queries. Allowed enum values: `apm_metrics`group_by[string]Optional fields to group the query results by.name [*required*]stringName of this query to use in formulas.operation_modestringOptional operation mode to aggregate across operation names.operation_namestringName of operation on service. If not provided, the primary operation name is used.peer_tags[string]Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).query_filterstringAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).resource_hashstringThe hash of a specific resource to filter by.resource_namestringThe full name of a specific resource to filter by.servicestringAPM service name.span_kindenumDescribes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal`stat [*required*]enumAPM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`Show 6 more`,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex` Option 7objectA formula and functions metrics query.additional_query_filtersstringAdditional filters applied to the SLO query.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for SLO measures queries. Allowed enum values: `slo`group_modeenumGroup mode to query measures. Allowed enum values: `overall,components`measure [*required*]enumSLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`namestringName of the query for use in formulas.slo_id [*required*]stringID of an SLO to query measures.slo_query_typeenumName of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` Option 8objectA formula and functions Cloud Cost query.aggregatorenumAggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for Cloud Cost queries. Allowed enum values: `cloud_cost`name [*required*]stringName of the query for use in formulas.query [*required*]stringQuery for Cloud Cost data. Option 9objectA formula and functions Product Analytics Extended query for advanced analytics features. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery. compute [*required*]objectCompute configuration for Product Analytics Extended queries.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervaldoubleFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`.metricstringMeasurable attribute to compute.namestringName of the compute for use in formulas. rollupobjectCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`.alignmentstringAlignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`).quantityint64Quantity of the interval.timezonestringTimezone for the interval.type [*required*]enumType of calendar interval. Allowed enum values: `day,week,month,year,quarter,minute,hour`data_source [*required*]enumData source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended` group_by[object]Group by configuration.facet [*required*]stringFacet name to group by.limitint32Maximum number of groups to return.should_exclude_missingbooleanWhether to exclude events missing the group-by facet. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` indexes[string]Event indexes to query.name [*required*]stringName of the query for use in formulas. query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. Option 10objectA formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. compute [*required*]objectCompute configuration for User Journey formula queries.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervaldoubleTime bucket interval in milliseconds for time series queries.metricenumMetric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion,__dd.conversion_rate,__dd.time_to_convert` targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.data_source [*required*]enumData source for user journey funnel queries. Allowed enum values: `product_analytics_journey` group_by[object]Group by configuration.facet [*required*]stringFacet name to group by.limitint32Maximum number of groups to return.should_exclude_missingbooleanWhether to exclude events missing the group-by facet. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.name [*required*]stringName of the query for use in formulas. search [*required*]objectUser journey search configuration.expression [*required*]stringExpression string. filtersobjectFilters for user journey search. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery. graph_filters[object]Graph filters.namestringFilter name.operatorstringFilter operator. targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.valueint64Filter value.string_filterstringString filter. join_keysobjectJoin keys for user journey queries.primary [*required*]stringPrimary join key.secondary[string]Secondary join keys. node_objects [*required*]objectNode objects mapping. objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. step_aliasesobjectStep aliases mapping.string Option 11objectA formula and functions Retention query for defining timeseries and scalar visualizations. compute [*required*]objectCompute configuration for retention queries. aggregation [*required*] The type of aggregation that can be performed on events-based queries.Option 1enumStandard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent`Show 1 more`,sum` Option 2stringPercentile aggregation.metric [*required*]enumMetric for retention compute. Allowed enum values: `__dd.retention,__dd.retention_rate`data_source [*required*]enumData source for retention queries. Allowed enum values: `product_analytics_retention` group_by[object]Group by configuration.facet [*required*]stringFacet to group by.limitint64Maximum number of groups.should_exclude_missingbooleanWhether to exclude missing values. sortobjectSort configuration for retention group by.orderenumWidget sorting methods. Allowed enum values: `asc,desc`sourcestringSource field.target [*required*]enumTarget for retention group by. Allowed enum values: `cohort,return_period`name [*required*]stringName of the query for use in formulas. search [*required*]objectSearch configuration for retention queries. cohort_criteria [*required*]objectCohort criteria for retention queries. base_query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. time_interval [*required*]objectTime interval for cohort criteria.type [*required*]enumType of time interval for cohort criteria. Allowed enum values: `calendar` value [*required*]objectCalendar interval definition.alignmentstringAlignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`).quantityint64Quantity of the interval.timezonestringTimezone for the interval.type [*required*]enumType of calendar interval. Allowed enum values: `day,week,month,year,quarter,minute,hour` filtersobjectFilters for retention queries. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery.string_filterstringString filter.retention_entity [*required*]enumEntity to track for retention. Allowed enum values: `@usr.id,@account.id`return_condition [*required*]enumCondition for counting user return. Allowed enum values: `conversion_on,conversion_on_or_after` return_criteriaobjectReturn criteria for retention queries. base_query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. time_intervalobjectTime interval for return criteria.type [*required*]enumType of time interval for return criteria. Allowed enum values: `fixed`unit [*required*]enumUnit of time for retention return criteria interval. Allowed enum values: `day,week,month`value [*required*]doubleValue of the time interval.response_format [*required*]enumResponse format for the scalar formula request. Only `scalar` is supported. Allowed enum values: `scalar`filterstringFilter string for the entity set in tag format (for example, `env:prod`). group_by[object]Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy.column [*required*]stringColumn name from the entity table (for example, `cloud_provider`, `tags`, `labels`).keystringKey within the column for nested attribute types (for example, `service` within `tags`).no_group_hostsbooleanWhether to hide entities that have no group assignment.no_metric_hostsbooleanWhether to hide entities that have no enrichment data.node_type [*required*]enumWhich type of infrastructure entity to visualize in the host map. Allowed enum values: `host,container,pod,cluster`request_type [*required*]enumIdentifies this as an infrastructure-backed host map request. Allowed enum values: `infrastructure_hostmap` styleobjectStyle configuration for the infrastructure host map.fill_maxdoubleMaximum value for the fill color scale. Omit to use automatic scaling.fill_mindoubleMinimum value for the fill color scale. Omit to use automatic scaling.palettestringColor palette name or alias.palette_flipbooleanWhether to invert the color palette. conditional_formats[object]List of conditional formatting rules applied to fill values.comparator [*required*]enumComparator to apply. Allowed enum values: `=,>,>=,<,<=`custom_bg_colorstringColor palette to apply to the background, same values available as palette.custom_fg_colorstringColor palette to apply to the foreground, same values available as palette.hide_valuebooleanTrue hides values.image_urlstringDisplays an image as the background.metricstringMetric from the request to correlate this conditional format with.palette [*required*]enumColor palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white`Show 9 more`,white_on_gray,white_on_green,green_on_white,white_on_red,white_on_yellow,yellow_on_white,black_on_light_yellow,black_on_light_green,black_on_light_red` timeframestringDefines the displayed timeframe.value [*required*]doubleValue for the comparator. enrichments[object]Metric or event queries joined to the entity set. Each formula specifies a visual dimension. formulas [*required*][object]List of formulas that operate on queries, each assigned to a visual dimension.aliasstringExpression alias.dimension [*required*]enumVisual dimension driven by a formula in the infrastructure host map widget. Allowed enum values: `node,fill,size`formula [*required*]stringString expression built from queries, formulas, and functions. number_formatobjectNumber format options for the widget. unit Number format unit. Option 1objectCanonical unit.per_unit_namestringThe name of the unit per item.typeenumThe type of unit scale. Allowed enum values: `canonical_unit`unit_namestringThe name of the unit. Option 2objectCustom unit.labelstringThe label for the custom unit.typeenumThe type of custom unit. Allowed enum values: `custom_unit_label` unit_scaleobjectThe definition of `NumberFormatUnitScale` object.typeenumThe type of unit scale. Allowed enum values: `canonical_unit`unit_namestringThe name of the unit. queries [*required*][ ]List of queries that can be returned directly or used in formulas. Option 1objectA formula and functions metrics query.aggregatorenumThe aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for metrics queries. Allowed enum values: `metrics`name [*required*]stringName of the query for use in formulas.query [*required*]stringMetrics query definition.semantic_modeenumSemantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` Option 2objectA formula and functions events query. compute [*required*]objectCompute options.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervalint64A time interval in milliseconds.metricstringMeasurable attribute to compute.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines`Show 5 more`,incident_analytics,product_analytics,on_call_events,errors,llm_observability` group_by Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. Option 1[object]List of objects used to group by.facet [*required*]stringEvent facet.limitint64Number of groups to return. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` Option 2objectFlat group by configuration using multiple event facet fields.fields [*required*][string]List of event facets to group by.limitint64Number of groups to return. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` indexes[string]An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.name [*required*]stringName of the query for use in formulas. searchobjectSearch options.query [*required*]stringEvents search string.storagestringOption for storage location. Feature in Private Beta. Option 3objectProcess query using formulas and functions.aggregatorenumThe aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData sources that rely on the process backend. Allowed enum values: `process,container`is_normalized_cpubooleanWhether to normalize the CPU percentages.limitint64Number of hits to return.metric [*required*]stringProcess metric name.name [*required*]stringName of query for use in formulas.sortenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` tag_filters[string]An array of tags to filter by.text_filterstringText to use as filter. Option 4objectA formula and functions APM dependency stats query.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`env [*required*]stringAPM environment.is_upstreambooleanDetermines whether stats for upstream or downstream dependencies should be queried.name [*required*]stringName of query to use in formulas.operation_name [*required*]stringName of operation on service.primary_tag_namestringThe name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope.md#add-a-second-primary-tag-in-datadog).primary_tag_valuestringFilter APM data by the second primary tag. `primary_tag_name` must also be specified.resource_name [*required*]stringAPM resource.service [*required*]stringAPM service.stat [*required*]enumAPM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` Option 5object**DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for APM resource stats queries. Allowed enum values: `apm_resource_stats`env [*required*]stringAPM environment.group_by[string]Array of fields to group results by.name [*required*]stringName of this query to use in formulas.operation_namestringName of operation on service.primary_tag_namestringName of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope.md#add-a-second-primary-tag-in-datadog)primary_tag_valuestringValue of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified.resource_namestringAPM resource name.service [*required*]stringAPM service name.stat [*required*]enumAPM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95`Show 1 more`,latency_p99` Option 6objectA formula and functions APM metrics query.data_source [*required*]enumData source for APM metrics queries. Allowed enum values: `apm_metrics`group_by[string]Optional fields to group the query results by.name [*required*]stringName of this query to use in formulas.operation_modestringOptional operation mode to aggregate across operation names.operation_namestringName of operation on service. If not provided, the primary operation name is used.peer_tags[string]Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).query_filterstringAdditional filters for the query using metrics query syntax (e.g., env, primary_tag).resource_hashstringThe hash of a specific resource to filter by.resource_namestringThe full name of a specific resource to filter by.servicestringAPM service name.span_kindenumDescribes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal`stat [*required*]enumAPM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99`Show 6 more`,latency_p999,latency_distribution,hits,hits_per_second,total_time,apdex` Option 7objectA formula and functions metrics query.additional_query_filtersstringAdditional filters applied to the SLO query.cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for SLO measures queries. Allowed enum values: `slo`group_modeenumGroup mode to query measures. Allowed enum values: `overall,components`measure [*required*]enumSLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown`namestringName of the query for use in formulas.slo_id [*required*]stringID of an SLO to query measures.slo_query_typeenumName of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` Option 8objectA formula and functions Cloud Cost query.aggregatorenumAggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile`cross_org_uuids[string]The source organization UUID for cross organization queries. Feature in Private Beta.data_source [*required*]enumData source for Cloud Cost queries. Allowed enum values: `cloud_cost`name [*required*]stringName of the query for use in formulas.query [*required*]stringQuery for Cloud Cost data. Option 9objectA formula and functions Product Analytics Extended query for advanced analytics features. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery. compute [*required*]objectCompute configuration for Product Analytics Extended queries.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervaldoubleFixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`.metricstringMeasurable attribute to compute.namestringName of the compute for use in formulas. rollupobjectCalendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`.alignmentstringAlignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`).quantityint64Quantity of the interval.timezonestringTimezone for the interval.type [*required*]enumType of calendar interval. Allowed enum values: `day,week,month,year,quarter,minute,hour`data_source [*required*]enumData source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended` group_by[object]Group by configuration.facet [*required*]stringFacet name to group by.limitint32Maximum number of groups to return.should_exclude_missingbooleanWhether to exclude events missing the group-by facet. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` indexes[string]Event indexes to query.name [*required*]stringName of the query for use in formulas. query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. Option 10objectA formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. compute [*required*]objectCompute configuration for User Journey formula queries.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` intervaldoubleTime bucket interval in milliseconds for time series queries.metricenumMetric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion,__dd.conversion_rate,__dd.time_to_convert` targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.data_source [*required*]enumData source for user journey funnel queries. Allowed enum values: `product_analytics_journey` group_by[object]Group by configuration.facet [*required*]stringFacet name to group by.limitint32Maximum number of groups to return.should_exclude_missingbooleanWhether to exclude events missing the group-by facet. sortobjectOptions for sorting group by results.aggregation [*required*]enumAggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min`Show 2 more`,max,avg` metricstringMetric used for sorting group by results.orderenumDirection of sort. Allowed enum values: `asc,desc` default: `desc` targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.name [*required*]stringName of the query for use in formulas. search [*required*]objectUser journey search configuration.expression [*required*]stringExpression string. filtersobjectFilters for user journey search. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery. graph_filters[object]Graph filters.namestringFilter name.operatorstringFilter operator. targetobjectTarget for user journey search.endstringEnd value.startstringStart value.type [*required*]stringTarget type.valuestringTarget value.valueint64Filter value.string_filterstringString filter. join_keysobjectJoin keys for user journey queries.primary [*required*]stringPrimary join key.secondary[string]Secondary join keys. node_objects [*required*]objectNode objects mapping. objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. step_aliasesobjectStep aliases mapping.string Option 11objectA formula and functions Retention query for defining timeseries and scalar visualizations. compute [*required*]objectCompute configuration for retention queries. aggregation [*required*] The type of aggregation that can be performed on events-based queries.Option 1enumStandard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent`Show 1 more`,sum` Option 2stringPercentile aggregation.metric [*required*]enumMetric for retention compute. Allowed enum values: `__dd.retention,__dd.retention_rate`data_source [*required*]enumData source for retention queries. Allowed enum values: `product_analytics_retention` group_by[object]Group by configuration.facet [*required*]stringFacet to group by.limitint64Maximum number of groups.should_exclude_missingbooleanWhether to exclude missing values. sortobjectSort configuration for retention group by.orderenumWidget sorting methods. Allowed enum values: `asc,desc`sourcestringSource field.target [*required*]enumTarget for retention group by. Allowed enum values: `cohort,return_period`name [*required*]stringName of the query for use in formulas. search [*required*]objectSearch configuration for retention queries. cohort_criteria [*required*]objectCohort criteria for retention queries. base_query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. time_interval [*required*]objectTime interval for cohort criteria.type [*required*]enumType of time interval for cohort criteria. Allowed enum values: `calendar` value [*required*]objectCalendar interval definition.alignmentstringAlignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`).quantityint64Quantity of the interval.timezonestringTimezone for the interval.type [*required*]enumType of calendar interval. Allowed enum values: `day,week,month,year,quarter,minute,hour` filtersobjectFilters for retention queries. audience_filtersobjectProduct Analytics/RUM audience filters. accounts[object]namestringThe name of the account subquery.querystringThe query string for the account subquery.filter_conditionstringAn optional filter condition applied to the audience subquery. segments[object]namestringThe name of the segment subquery.segment_idstringThe unique identifier of the segment. users[object]namestringThe name of the user subquery.querystringThe query string for the user subquery.string_filterstringString filter.retention_entity [*required*]enumEntity to track for retention. Allowed enum values: `@usr.id,@account.id`return_condition [*required*]enumCondition for counting user return. Allowed enum values: `conversion_on,conversion_on_or_after` return_criteriaobjectReturn criteria for retention queries. base_query [*required*]objectBase query for Product Analytics.data_source [*required*]enumData source for Product Analytics event queries. Allowed enum values: `product_analytics` search [*required*]objectSearch configuration for Product Analytics event query.query [*required*]stringRUM event search query used to filter views or actions. time_intervalobjectTime interval for return criteria.type [*required*]enumType of time interval for return criteria. Allowed enum values: `fixed`unit [*required*]enumUnit of time for retention return criteria interval. Allowed enum values: `day,week,month`value [*required*]doubleValue of the time interval.response_format [*required*]enumResponse format for the scalar formula request. Only `scalar` is supported. Allowed enum values: `scalar` fillobjectUpdated host map. apm_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. event_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. log_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. network_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. process_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead.filter_by[string]List of processes.limitint64Max number of items in the filter list.metric [*required*]stringYour chosen metric.search_bystringYour chosen search term. profile_metrics_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply.qstringQuery definition. rum_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. security_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply.filterstringFilter string for the entity set in tag format (for example, `env:prod`). group_by[object]Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy.column [*required*]stringColumn name from the entity table (for example, `cloud_provider`, `tags`, `labels`).keystringKey within the column for nested attribute types (for example, `service` within `tags`).no_group_hostsbooleanWhether to hide entities that have no group assignment.no_metric_hostsbooleanWhether to hide entities that have no enrichment data.node_typeenumWhich type of infrastructure entity to visualize in the host map. Allowed enum values: `host,container,pod,cluster`request_typeenumIdentifies this as an infrastructure-backed host map request. Allowed enum values: `infrastructure_hostmap` sizeobjectUpdated host map. apm_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. event_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. log_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. network_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. process_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead.filter_by[string]List of processes.limitint64Max number of items in the filter list.metric [*required*]stringYour chosen metric.search_bystringYour chosen search term. profile_metrics_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply.qstringQuery definition. rum_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. security_queryobject**DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. computeobjectDefine computation for a log query.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. group_by[object]List of tag prefixes to group by in the case of a cluster check.facet [*required*]stringFacet name.limitint64Maximum number of items in the group. sortobjectDefine a sorting method.aggregation [*required*]stringThe aggregation method.facetstringFacet name.order [*required*]enumWidget sorting methods. Allowed enum values: `asc,desc`indexstringA coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes.md#multiple-indexes) multi_compute[object]This field is mutually exclusive with `compute`.aggregation [*required*]stringThe aggregation method.facetstringFacet name.intervalint64Define a time interval in seconds. searchobjectThe query being made on the logs.query [*required*]stringSearch value to apply. styleobjectStyle configuration for the infrastructure host map.fill_maxdoubleMaximum value for the fill color scale. Omit to use automatic scaling.fill_mindoubleMinimum value for the fill color scale. Omit to use automatic scaling.palettestringColor palette name or alias.palette_flipbooleanWhether to invert the color palette.scope[string]List of tags used to filter the map. styleobjectThe style to apply to the widget.fill_maxstringMax value to use to color the map.fill_minstringMin value to use to color the map.palettestringColor palette to apply to the widget.palette_flipbooleanWhether to flip the palette tones.titlestringTitle of the widget.title_alignenumHow to align the text on the widget. Allowed enum values: `center,left,right`title_sizestringSize of the title.type [*required*]enumType of the host map widget. Allowed enum values: `hostmap` default: `hostmap` {% /tab %} {% tab title="example" %} ```json { "custom_links": [ { "is_hidden": false, "label": "Search logs for {{host}}", "link": "https://app.datadoghq.com/logs?query={{host}}", "override_label": "logs" } ], "description": "string", "group": [], "no_group_hosts": false, "no_metric_hosts": false, "node_type": "string", "notes": "string", "requests": { "child": { "child": { "conditional_formats": [ { "comparator": ">", "custom_bg_color": "string", "custom_fg_color": "string", "hide_value": false, "image_url": "string", "metric": "string", "palette": "blue", "timeframe": "string", "value": 0 } ], "enrichments": [ { "formulas": [ { "alias": "my-metric", "dimension": "node", "formula": "query1", "number_format": { "unit": { "per_unit_name": "bytes", "type": "canonical_unit", "unit_name": "bytes" }, "unit_scale": { "type": "canonical_unit", "unit_name": "bytes" } } } ], "queries": [ [] ], "response_format": "scalar" } ], "filter": "env:prod", "group_by": [ { "column": "tags", "key": "service" } ], "no_group_hosts": false, "no_metric_hosts": false, "node_type": "host", "request_type": "infrastructure_hostmap", "style": { "fill_max": "number", "fill_min": "number", "palette": "hostmap_blues", "palette_flip": false } }, "conditional_formats": [ { "comparator": ">", "custom_bg_color": "string", "custom_fg_color": "string", "hide_value": false, "image_url": "string", "metric": "string", "palette": "blue", "timeframe": "string", "value": 0 } ], "enrichments": [ { "formulas": [ { "alias": "my-metric", "dimension": "node", "formula": "query1", "number_format": { "unit": { "per_unit_name": "bytes", "type": "canonical_unit", "unit_name": "bytes" }, "unit_scale": { "type": "canonical_unit", "unit_name": "bytes" } } } ], "queries": [ [] ], "response_format": "scalar" } ], "filter": "env:prod", "group_by": [ { "column": "tags", "key": "service" } ], "no_group_hosts": false, "no_metric_hosts": false, "node_type": "host", "request_type": "infrastructure_hostmap", "style": { "fill_max": "number", "fill_min": "number", "palette": "hostmap_blues", "palette_flip": false } }, "conditional_formats": [ { "comparator": ">", "custom_bg_color": "string", "custom_fg_color": "string", "hide_value": false, "image_url": "string", "metric": "string", "palette": "blue", "timeframe": "string", "value": 0 } ], "enrichments": [ { "formulas": [ { "alias": "my-metric", "dimension": "node", "formula": "query1", "number_format": { "unit": { "per_unit_name": "bytes", "type": "canonical_unit", "unit_name": "bytes" }, "unit_scale": { "type": "canonical_unit", "unit_name": "bytes" } } } ], "queries": [ [] ], "response_format": "scalar" } ], "fill": { "apm_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "event_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "log_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "network_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "process_query": { "filter_by": [], "limit": "integer", "metric": "system.load.1", "search_by": "string" }, "profile_metrics_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "q": "string", "rum_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "security_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } } }, "filter": "env:prod", "group_by": [ { "column": "tags", "key": "service" } ], "no_group_hosts": false, "no_metric_hosts": false, "node_type": "host", "request_type": "infrastructure_hostmap", "size": { "apm_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "event_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "log_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "network_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "process_query": { "filter_by": [], "limit": "integer", "metric": "system.load.1", "search_by": "string" }, "profile_metrics_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "q": "string", "rum_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } }, "security_query": { "compute": { "aggregation": "avg", "facet": "@duration", "interval": 5000 }, "group_by": [ { "facet": "resource_name", "limit": 50, "sort": { "aggregation": "avg", "facet": "@string_query.interval", "order": "desc" } } ], "index": "days-3,days-7", "multi_compute": [ { "aggregation": "avg", "facet": "@duration", "interval": 5000 } ], "search": { "query": "" } } }, "style": { "fill_max": "number", "fill_min": "number", "palette": "hostmap_blues", "palette_flip": false } }, "scope": [], "style": { "fill_max": "string", "fill_min": "string", "palette": "string", "palette_flip": false }, "title": "string", "title_align": "string", "title_size": "string", "type": "hostmap" } ``` {% /tab %} {% /tab %} ## Further Reading{% #further-reading %} - [Building Dashboards using JSON](https://docs.datadoghq.com/dashboards/graphing_json.md)