--- 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/) page: {% image source="https://datadog-docs.imgix.net/images/dashboards/widgets/hostmap/hostmap.e3ed7a7e8d381986676e0e399eea9157.png?auto=format" alt="Host Map" /%} ## Setup{% #setup %} {% image source="https://datadog-docs.imgix.net/images/dashboards/widgets/hostmap/hostmap_setup.565d79299814f39be5b9e3e03bebe2d3.png?auto=format" 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/) 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/) 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/)**. See the following table for the [widget JSON schema definition](https://docs.datadoghq.com/dashboards/graphing_json/widget_json/): {% 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*]objectList of definitions. 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/#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/#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/#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/#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/#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/#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/#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. 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/#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/#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/#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/#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/#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/#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/#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.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": { "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": "" } } }, "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": "" } } } }, "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/)